Batch Deployments - List

Service:: Machine Learning

API Version:: 2025-12-01

Lists Batch inference deployments in the workspace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2025-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2025-12-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Name for the Batch Endpoint.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning Workspace Name
api-version	query	True	string minLength: 1	The API version to use for this operation.
$orderBy	query		string	Ordering of list.
$skip	query		string	Continuation token for pagination.
$top	query		integer (int32)	Top of list.

Responses

Name	Type	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Workspace Batch Deployment.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-12-01&$orderBy=string&$top=1

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-07-01-preview&$skip=2",
  "value": [
    {
      "name": "string",
      "type": "string",
      "id": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "clientId": "00000000-1111-2222-3333-444444444444",
            "principalId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "kind": "string",
      "location": "string",
      "properties": {
        "description": "string",
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "compute": "string",
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "errorThreshold": 1,
        "loggingLevel": "Info",
        "maxConcurrencyPerInstance": 1,
        "miniBatchSize": 1,
        "model": {
          "assetId": "string",
          "referenceType": "Id"
        },
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "properties": {
          "string": "string"
        },
        "provisioningState": "Creating",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        }
      },
      "sku": {
        "name": "string",
        "capacity": 1,
        "family": "string",
        "size": "string",
        "tier": "Free"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {}
    }
  ]
}

Definitions

Name	Description
BatchDeployment	Concrete tracked resource types can be created by aliasing this type using a specific property type.
BatchDeploymentConfigurationType	The enumerated property types for batch deployments.
BatchDeploymentProperties	Batch inference settings per deployment.
BatchDeploymentTrackedResourceArmPaginatedResult	A paginated list of BatchDeployment entities.
BatchLoggingLevel	Log verbosity for batch inferencing. Increasing verbosity order for logging is : Warning, Info and Debug. The default value is Info.
BatchOutputAction	Enum to determine how batch inferencing will handle output
BatchPipelineComponentDeploymentConfiguration	Properties for a Batch Pipeline Component Deployment.
BatchRetrySettings	Retry settings for a batch inference operation.
CodeConfiguration	Configuration for a scoring code asset.
createdByType	The type of identity that created the resource.
DataPathAssetReference	Reference to an asset via its path in a datastore.
DeploymentProvisioningState	Possible values for DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdAssetReference	Reference to an asset via its ARM resource ID.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
OutputPathAssetReference	Reference to an asset via its path in a job output.
ReferenceType	Enum to determine which reference method to use for an asset.
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

BatchDeployment

Object

Concrete tracked resource types can be created by aliasing this type using a specific property type.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	BatchDeploymentProperties	[Required] Additional attributes of the entity.
sku	Sku	Sku details required for ARM contract for Autoscaling.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BatchDeploymentConfigurationType

Enumeration

The enumerated property types for batch deployments.

Value	Description
Model
PipelineComponent

BatchDeploymentProperties

Object

Batch inference settings per deployment.

Name	Type	Default value	Description
codeConfiguration	CodeConfiguration		Code configuration for the endpoint deployment.
compute	string		Compute target for batch inference operation.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Properties relevant to different deployment types.
description	string		Description of the endpoint deployment.
environmentId	string		ARM resource ID or AssetId of the environment specification for the endpoint deployment.
environmentVariables	object		Environment variables configuration for the deployment.
errorThreshold	integer (int32)	-1	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.
loggingLevel	BatchLoggingLevel	Info	Log verbosity for batch inferencing. Increasing verbosity order for logging is : Warning, Info and Debug. The default value is Info.
maxConcurrencyPerInstance	integer (int32)	1	Indicates maximum number of parallelism per instance.
miniBatchSize	integer (int64)	10	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.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Reference to the model asset for the endpoint deployment.
outputAction	BatchOutputAction	AppendRow	Enum to determine how batch inferencing will handle output
outputFileName	string	predictions.csv	Customized output file name for append_row output action.
properties	object		Property dictionary. Properties can be added, but not removed or altered.
provisioningState	DeploymentProvisioningState		Provisioning state for the endpoint deployment.
resources	DeploymentResourceConfiguration		Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
retrySettings	BatchRetrySettings		Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.

BatchDeploymentTrackedResourceArmPaginatedResult

Object

A paginated list of BatchDeployment entities.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	BatchDeployment[]	The BatchDeployment items on this page

BatchLoggingLevel

Enumeration

Log verbosity for batch inferencing. Increasing verbosity order for logging is : Warning, Info and Debug. The default value is Info.

Value	Description
Info
Warning
Debug

BatchOutputAction

Enumeration

Enum to determine how batch inferencing will handle output

Value	Description
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Object

Properties for a Batch Pipeline Component Deployment.

Name	Type	Description
componentId	IdAssetReference	The ARM id of the component to be run.
deploymentConfigurationType	string: PipelineComponent	[Required] The type of the deployment
description	string	The description which will be applied to the job.
settings	object	Run-time settings for the pipeline job.
tags	object	The tags which will be applied to the job.

BatchRetrySettings

Object

Retry settings for a batch inference operation.

Name	Type	Default value	Description
maxRetries	integer (int32)	3	Maximum retry count for a mini-batch
timeout	string (duration)	PT30S	Invocation timeout for a mini-batch, in ISO 8601 format.

CodeConfiguration

Object

Configuration for a scoring code asset.

Name	Type	Description
codeId	string	ARM resource ID of the code asset.
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Required] The script to execute on startup. eg. "score.py"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DataPathAssetReference

Object

Reference to an asset via its path in a datastore.

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

DeploymentProvisioningState

Enumeration

Possible values for DeploymentProvisioningState.

Value	Description
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Object

Name	Type	Default value	Description
instanceCount	integer (int32)	1	Optional number of instances or nodes used by the compute target.
instanceType	string		Optional type of VM used as supported by the compute target.
properties			Additional properties bag.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdAssetReference

Object

Reference to an asset via its ARM resource ID.

Name	Type	Description
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Required] ARM resource ID of the asset.
referenceType	string: Id	[Required] Specifies the type of asset reference.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Object

Reference to an asset via its path in a job output.

Name	Type	Description
jobId	string	ARM resource ID of the job.
path	string	The path of the file/directory in the job output.
referenceType	string: OutputPath	[Required] Specifies the type of asset reference.

ReferenceType

Enumeration

Enum to determine which reference method to use for an asset.

Value	Description
Id
DataPath
OutputPath

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Free
Basic
Standard
Premium

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

Batch Deployments - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Workspace Batch Deployment.

Sample request

Sample response

Definitions

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentProperties

BatchDeploymentTrackedResourceArmPaginatedResult

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity