Microsoft.MachineLearningServices workspaces/batchEndpoints/deployments 2021-03-01-preview
Bicep resource definition
The workspaces/batchEndpoints/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/batchEndpoints/deployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: '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'
}
}
}
AssetReferenceBase objects
Set the referenceType property to specify the type of object.
For DataPath, use:
referenceType: 'DataPath'
datastoreId: 'string'
path: 'string'
For Id, use:
referenceType: 'Id'
assetId: 'string'
For OutputPath, use:
referenceType: 'OutputPath'
jobId: 'string'
path: 'string'
Property values
workspaces/batchEndpoints/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| 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: batchEndpoints |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | BatchDeployment (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 |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
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 |
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 |
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 (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
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 |
|---|---|---|
| {customized property} | string |
BatchDeploymentEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AssetReferenceBase
| Name | Description | Value |
|---|---|---|
| referenceType | Set the object type | DataPath Id OutputPath (required) |
DataPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'DataPath' (required) |
| datastoreId | ARM resource ID of the datastore where the asset is located. | string |
| path | The path of the file/directory in the datastore. | string |
IdAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'Id' (required) |
| assetId | [Required] ARM resource ID of the asset. | string (required) Constraints: Pattern = [a-zA-Z0-9_] |
OutputPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'OutputPath' (required) |
| jobId | ARM resource ID of the job. | string |
| path | The path of the file/directory in the job output. | string |
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' |
BatchDeploymentProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
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 |
ARM template resource definition
The workspaces/batchEndpoints/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/batchEndpoints/deployments resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments",
"apiVersion": "2021-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "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"
}
}
}
AssetReferenceBase objects
Set the referenceType property to specify the type of object.
For DataPath, use:
"referenceType": "DataPath",
"datastoreId": "string",
"path": "string"
For Id, use:
"referenceType": "Id",
"assetId": "string"
For OutputPath, use:
"referenceType": "OutputPath",
"jobId": "string",
"path": "string"
Property values
workspaces/batchEndpoints/deployments
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments' |
| apiVersion | The resource api version | '2021-03-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | BatchDeployment (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 |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
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 |
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 |
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 (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
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 |
|---|---|---|
| {customized property} | string |
BatchDeploymentEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AssetReferenceBase
| Name | Description | Value |
|---|---|---|
| referenceType | Set the object type | DataPath Id OutputPath (required) |
DataPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'DataPath' (required) |
| datastoreId | ARM resource ID of the datastore where the asset is located. | string |
| path | The path of the file/directory in the datastore. | string |
IdAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'Id' (required) |
| assetId | [Required] ARM resource ID of the asset. | string (required) Constraints: Pattern = [a-zA-Z0-9_] |
OutputPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | 'OutputPath' (required) |
| jobId | ARM resource ID of the job. | string |
| path | The path of the file/directory in the job output. | string |
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' |
BatchDeploymentProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
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 |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
}
kind = "string"
})
}
AssetReferenceBase objects
Set the referenceType property to specify the type of object.
For DataPath, use:
referenceType = "DataPath"
datastoreId = "string"
path = "string"
For Id, use:
referenceType = "Id"
assetId = "string"
For OutputPath, use:
referenceType = "OutputPath"
jobId = "string"
path = "string"
Property values
workspaces/batchEndpoints/deployments
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: batchEndpoints |
| tags | Resource tags. | Dictionary of tag names and values. |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | BatchDeployment (required) |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Defines values for a ResourceIdentity's type. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Dictionary of the user assigned identities, key is ARM resource ID of the UAI. | Array of user identity IDs. |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
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 |
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 |
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 (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
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 |
|---|---|---|
| {customized property} | string |
BatchDeploymentEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AssetReferenceBase
| Name | Description | Value |
|---|---|---|
| referenceType | Set the object type | DataPath Id OutputPath (required) |
DataPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | "DataPath" (required) |
| datastoreId | ARM resource ID of the datastore where the asset is located. | string |
| path | The path of the file/directory in the datastore. | string |
IdAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | "Id" (required) |
| assetId | [Required] ARM resource ID of the asset. | string (required) Constraints: Pattern = [a-zA-Z0-9_] |
OutputPathAssetReference
| Name | Description | Value |
|---|---|---|
| referenceType | [Required] Specifies the type of asset reference. | "OutputPath" (required) |
| jobId | ARM resource ID of the job. | string |
| path | The path of the file/directory in the job output. | string |
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" |
BatchDeploymentProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for