Share via

Microsoft.MachineLearningServices workspaces/batchEndpoints/deployments 2021-03-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    codeConfiguration: {
      codeId: 'string'
      scoringScript: 'string'
    }
    compute: {
      instanceCount: int
      instanceType: 'string'
      isLocal: bool
      location: 'string'
      properties: {
        {customized property}: 'string'
      }
      target: 'string'
    }
    description: 'string'
    environmentId: 'string'
    environmentVariables: {
      {customized property}: 'string'
    }
    errorThreshold: int
    loggingLevel: 'string'
    miniBatchSize: int
    model: {
      referenceType: 'string'
      // For remaining properties, see AssetReferenceBase objects
    }
    outputConfiguration: {
      appendRowFileName: 'string'
      outputAction: 'string'
    }
    partitionKeys: [
      'string'
    ]
    properties: {
      {customized property}: 'string'
    }
    retrySettings: {
      maxRetries: int
      timeout: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

AssetReferenceBase objects

Set the referenceType property to specify the type of object.

For DataPath, use:

{
  datastoreId: 'string'
  path: 'string'
  referenceType: 'DataPath'
}

For Id, use:

{
  assetId: 'string'
  referenceType: 'Id'
}

For OutputPath, use:

{
  jobId: 'string'
  path: 'string'
  referenceType: 'OutputPath'
}

Property values

AssetReferenceBase

Name Description Value
referenceType Set to 'DataPath' for type DataPathAssetReference. Set to 'Id' for type IdAssetReference. Set to 'OutputPath' for type OutputPathAssetReference. 'DataPath'
'Id'
'OutputPath' (required)

BatchDeployment

Name Description Value
codeConfiguration Code configuration for the endpoint deployment. CodeConfiguration
compute Configuration for compute binding. ComputeConfiguration
description Description of the endpoint deployment. string
environmentId ARM resource ID of the environment specification for the endpoint deployment. string
environmentVariables Environment variables configuration for the deployment. BatchDeploymentEnvironmentVariables
errorThreshold Error threshold, if the error count for the entire input goes above this value,
the batch inference will be aborted. Range is [-1, int.MaxValue].
For FileDataset, this value is the count of file failures.
For TabularDataset, this value is the count of record failures.
If set to -1 (the lower bound), all failures during batch inference will be ignored.		 int
loggingLevel Logging level for batch inference operation. 'Debug'
'Info'
'Warning'
miniBatchSize Size of the mini-batch passed to each batch invocation.
For FileDataset, this is the number of files per mini-batch.
For TabularDataset, this is the size of the records in bytes, per mini-batch.		 int
model Reference to the model asset for the endpoint deployment. AssetReferenceBase
outputConfiguration Output configuration for the batch inference operation. BatchOutputConfiguration
partitionKeys Partition keys list used for Named partitioning. string[]
properties Property dictionary. Properties can be added, but not removed or altered. BatchDeploymentProperties
retrySettings Retry Settings for the batch inference operation. BatchRetrySettings

BatchDeploymentEnvironmentVariables

Name Description Value

BatchDeploymentProperties

Name Description Value

BatchOutputConfiguration

Name Description Value
appendRowFileName Customized output file name for append_row output action. string
outputAction Indicates how the output will be organized. 'AppendRow'
'SummaryOnly'

BatchRetrySettings

Name Description Value
maxRetries Maximum retry count for a mini-batch int
timeout Invocation timeout for a mini-batch, in ISO 8601 format. string

CodeConfiguration

Name Description Value
codeId ARM resource ID of the code asset. string
scoringScript [Required] The script to execute on startup. eg. "score.py" string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

ComputeConfiguration

Name Description Value
instanceCount Number of instances or nodes. int
instanceType SKU type to run on. string
isLocal Set to true for jobs running on local compute. bool
location Location for virtual cluster run. string
properties Additional properties. ComputeConfigurationProperties
target ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed. string

ComputeConfigurationProperties

Name Description Value

DataPathAssetReference

Name Description Value
datastoreId ARM resource ID of the datastore where the asset is located. string
path The path of the file/directory in the datastore. string
referenceType [Required] Specifies the type of asset reference. 'DataPath' (required)

IdAssetReference

Name Description Value
assetId [Required] ARM resource ID of the asset. string

Constraints:
Pattern = [a-zA-Z0-9_] (required)
referenceType [Required] Specifies the type of asset reference. 'Id' (required)

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments

Name Description Value
identity Service identity associated with a resource. ResourceIdentity
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-Z0-9][a-zA-Z0-9\-_]{0,254}$ (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/batchEndpoints
properties [Required] Additional attributes of the entity. BatchDeployment (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

OutputPathAssetReference

Name Description Value
jobId ARM resource ID of the job. string
path The path of the file/directory in the job output. string
referenceType [Required] Specifies the type of asset reference. 'OutputPath' (required)

ResourceIdentity

Name Description Value
type Defines values for a ResourceIdentity's type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Dictionary of the user assigned identities, key is ARM resource ID of the UAI. ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

TrackedResourceTags

Name Description Value

UserAssignedIdentityMeta

Name Description Value
clientId Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. string
principalId The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. string

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "codeConfiguration": {
      "codeId": "string",
      "scoringScript": "string"
    },
    "compute": {
      "instanceCount": "int",
      "instanceType": "string",
      "isLocal": "bool",
      "location": "string",
      "properties": {
        "{customized property}": "string"
      },
      "target": "string"
    },
    "description": "string",
    "environmentId": "string",
    "environmentVariables": {
      "{customized property}": "string"
    },
    "errorThreshold": "int",
    "loggingLevel": "string",
    "miniBatchSize": "int",
    "model": {
      "referenceType": "string"
      // For remaining properties, see AssetReferenceBase objects
    },
    "outputConfiguration": {
      "appendRowFileName": "string",
      "outputAction": "string"
    },
    "partitionKeys": [ "string" ],
    "properties": {
      "{customized property}": "string"
    },
    "retrySettings": {
      "maxRetries": "int",
      "timeout": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

AssetReferenceBase objects

Set the referenceType property to specify the type of object.

For DataPath, use:

{
  "datastoreId": "string",
  "path": "string",
  "referenceType": "DataPath"
}

For Id, use:

{
  "assetId": "string",
  "referenceType": "Id"
}

For OutputPath, use:

{
  "jobId": "string",
  "path": "string",
  "referenceType": "OutputPath"
}

Property values

AssetReferenceBase

Name Description Value
referenceType Set to 'DataPath' for type DataPathAssetReference. Set to 'Id' for type IdAssetReference. Set to 'OutputPath' for type OutputPathAssetReference. 'DataPath'
'Id'
'OutputPath' (required)

BatchDeployment

Name Description Value
codeConfiguration Code configuration for the endpoint deployment. CodeConfiguration
compute Configuration for compute binding. ComputeConfiguration
description Description of the endpoint deployment. string
environmentId ARM resource ID of the environment specification for the endpoint deployment. string
environmentVariables Environment variables configuration for the deployment. BatchDeploymentEnvironmentVariables
errorThreshold Error threshold, if the error count for the entire input goes above this value,
the batch inference will be aborted. Range is [-1, int.MaxValue].
For FileDataset, this value is the count of file failures.
For TabularDataset, this value is the count of record failures.
If set to -1 (the lower bound), all failures during batch inference will be ignored.		 int
loggingLevel Logging level for batch inference operation. 'Debug'
'Info'
'Warning'
miniBatchSize Size of the mini-batch passed to each batch invocation.
For FileDataset, this is the number of files per mini-batch.
For TabularDataset, this is the size of the records in bytes, per mini-batch.		 int
model Reference to the model asset for the endpoint deployment. AssetReferenceBase
outputConfiguration Output configuration for the batch inference operation. BatchOutputConfiguration
partitionKeys Partition keys list used for Named partitioning. string[]
properties Property dictionary. Properties can be added, but not removed or altered. BatchDeploymentProperties
retrySettings Retry Settings for the batch inference operation. BatchRetrySettings

BatchDeploymentEnvironmentVariables

Name Description Value

BatchDeploymentProperties

Name Description Value

BatchOutputConfiguration

Name Description Value
appendRowFileName Customized output file name for append_row output action. string
outputAction Indicates how the output will be organized. 'AppendRow'
'SummaryOnly'

BatchRetrySettings

Name Description Value
maxRetries Maximum retry count for a mini-batch int
timeout Invocation timeout for a mini-batch, in ISO 8601 format. string

CodeConfiguration

Name Description Value
codeId ARM resource ID of the code asset. string
scoringScript [Required] The script to execute on startup. eg. "score.py" string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

ComputeConfiguration

Name Description Value
instanceCount Number of instances or nodes. int
instanceType SKU type to run on. string
isLocal Set to true for jobs running on local compute. bool
location Location for virtual cluster run. string
properties Additional properties. ComputeConfigurationProperties
target ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed. string

ComputeConfigurationProperties

Name Description Value

DataPathAssetReference

Name Description Value
datastoreId ARM resource ID of the datastore where the asset is located. string
path The path of the file/directory in the datastore. string
referenceType [Required] Specifies the type of asset reference. 'DataPath' (required)

IdAssetReference

Name Description Value
assetId [Required] ARM resource ID of the asset. string

Constraints:
Pattern = [a-zA-Z0-9_] (required)
referenceType [Required] Specifies the type of asset reference. 'Id' (required)

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments

Name Description Value
apiVersion The api version '2021-03-01-preview'
identity Service identity associated with a resource. ResourceIdentity
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-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
properties [Required] Additional attributes of the entity. BatchDeployment (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments'

OutputPathAssetReference

Name Description Value
jobId ARM resource ID of the job. string
path The path of the file/directory in the job output. string
referenceType [Required] Specifies the type of asset reference. 'OutputPath' (required)

ResourceIdentity

Name Description Value
type Defines values for a ResourceIdentity's type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Dictionary of the user assigned identities, key is ARM resource ID of the UAI. ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

TrackedResourceTags

Name Description Value

UserAssignedIdentityMeta

Name Description Value
clientId Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. string
principalId The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      codeConfiguration = {
        codeId = "string"
        scoringScript = "string"
      }
      compute = {
        instanceCount = int
        instanceType = "string"
        isLocal = bool
        location = "string"
        properties = {
          {customized property} = "string"
        }
        target = "string"
      }
      description = "string"
      environmentId = "string"
      environmentVariables = {
        {customized property} = "string"
      }
      errorThreshold = int
      loggingLevel = "string"
      miniBatchSize = int
      model = {
        referenceType = "string"
        // For remaining properties, see AssetReferenceBase objects
      }
      outputConfiguration = {
        appendRowFileName = "string"
        outputAction = "string"
      }
      partitionKeys = [
        "string"
      ]
      properties = {
        {customized property} = "string"
      }
      retrySettings = {
        maxRetries = int
        timeout = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

AssetReferenceBase objects

Set the referenceType property to specify the type of object.

For DataPath, use:

{
  datastoreId = "string"
  path = "string"
  referenceType = "DataPath"
}

For Id, use:

{
  assetId = "string"
  referenceType = "Id"
}

For OutputPath, use:

{
  jobId = "string"
  path = "string"
  referenceType = "OutputPath"
}

Property values

AssetReferenceBase

Name Description Value
referenceType Set to 'DataPath' for type DataPathAssetReference. Set to 'Id' for type IdAssetReference. Set to 'OutputPath' for type OutputPathAssetReference. 'DataPath'
'Id'
'OutputPath' (required)

BatchDeployment

Name Description Value
codeConfiguration Code configuration for the endpoint deployment. CodeConfiguration
compute Configuration for compute binding. ComputeConfiguration
description Description of the endpoint deployment. string
environmentId ARM resource ID of the environment specification for the endpoint deployment. string
environmentVariables Environment variables configuration for the deployment. BatchDeploymentEnvironmentVariables
errorThreshold Error threshold, if the error count for the entire input goes above this value,
the batch inference will be aborted. Range is [-1, int.MaxValue].
For FileDataset, this value is the count of file failures.
For TabularDataset, this value is the count of record failures.
If set to -1 (the lower bound), all failures during batch inference will be ignored.		 int
loggingLevel Logging level for batch inference operation. 'Debug'
'Info'
'Warning'
miniBatchSize Size of the mini-batch passed to each batch invocation.
For FileDataset, this is the number of files per mini-batch.
For TabularDataset, this is the size of the records in bytes, per mini-batch.		 int
model Reference to the model asset for the endpoint deployment. AssetReferenceBase
outputConfiguration Output configuration for the batch inference operation. BatchOutputConfiguration
partitionKeys Partition keys list used for Named partitioning. string[]
properties Property dictionary. Properties can be added, but not removed or altered. BatchDeploymentProperties
retrySettings Retry Settings for the batch inference operation. BatchRetrySettings

BatchDeploymentEnvironmentVariables

Name Description Value

BatchDeploymentProperties

Name Description Value

BatchOutputConfiguration

Name Description Value
appendRowFileName Customized output file name for append_row output action. string
outputAction Indicates how the output will be organized. 'AppendRow'
'SummaryOnly'

BatchRetrySettings

Name Description Value
maxRetries Maximum retry count for a mini-batch int
timeout Invocation timeout for a mini-batch, in ISO 8601 format. string

CodeConfiguration

Name Description Value
codeId ARM resource ID of the code asset. string
scoringScript [Required] The script to execute on startup. eg. "score.py" string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

ComputeConfiguration

Name Description Value
instanceCount Number of instances or nodes. int
instanceType SKU type to run on. string
isLocal Set to true for jobs running on local compute. bool
location Location for virtual cluster run. string
properties Additional properties. ComputeConfigurationProperties
target ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed. string

ComputeConfigurationProperties

Name Description Value

DataPathAssetReference

Name Description Value
datastoreId ARM resource ID of the datastore where the asset is located. string
path The path of the file/directory in the datastore. string
referenceType [Required] Specifies the type of asset reference. 'DataPath' (required)

IdAssetReference

Name Description Value
assetId [Required] ARM resource ID of the asset. string

Constraints:
Pattern = [a-zA-Z0-9_] (required)
referenceType [Required] Specifies the type of asset reference. 'Id' (required)

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments

Name Description Value
identity Service identity associated with a resource. ResourceIdentity
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-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces/batchEndpoints
properties [Required] Additional attributes of the entity. BatchDeployment (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview"

OutputPathAssetReference

Name Description Value
jobId ARM resource ID of the job. string
path The path of the file/directory in the job output. string
referenceType [Required] Specifies the type of asset reference. 'OutputPath' (required)

ResourceIdentity

Name Description Value
type Defines values for a ResourceIdentity's type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Dictionary of the user assigned identities, key is ARM resource ID of the UAI. ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

Name Description Value

TrackedResourceTags

Name Description Value

UserAssignedIdentityMeta

Name Description Value
clientId Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. string
principalId The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. string