Batch Deployments - List

服務:: Machine Learning

API 版本:: 2026-03-01

列出工作區中的批次推斷部署。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpointName	path	True	string	批次端點的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning 工作區名稱
api-version	query	True	string minLength: 1	用於此作業的 API 版本。
$orderBy	query		string	列表的順序。
$skip	query		string	分頁的接續權杖。
$top	query		integer (int32)	列表頂部。

回應

名稱	類型	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Azure 運作順利完成。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List Workspace Batch Deployment.

範例要求

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=2026-03-01&$orderBy=string&$top=1

範例回覆

狀態碼:: 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": {}
    }
  ]
}

定義

名稱	Description
BatchDeployment	您可以使用特定屬性類型來建立具象追蹤的資源類型。
BatchDeploymentConfigurationType	批次部署的列舉屬性類型。
BatchDeploymentProperties	每個部署的批次推論設定。
BatchDeploymentTrackedResourceArmPaginatedResult	BatchDeployment 實體的編頁清單。
BatchLoggingLevel	批次推斷的記錄詳細程度。記錄的詳細順序增加為：警告、資訊和偵錯。預設值為 Info。
BatchOutputAction	列舉，以決定批次推斷將如何處理輸出
BatchPipelineComponentDeploymentConfiguration	批次管線元件部署的屬性。
BatchRetrySettings	重試批次推論作業的設定。
CodeConfiguration	評分碼資產的配置。
createdByType	建立資源的身分識別類型。
DataPathAssetReference	透過資料存放區中的資產路徑參照資產。
DeploymentProvisioningState	DeploymentProvisioningState 的可能值。
DeploymentResourceConfiguration
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IdAssetReference	透過資產的 ARM 資源識別碼參照資產。
ManagedServiceIdentity	受控服務識別（系統指派和/或使用者指派的身分識別）
ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
OutputPathAssetReference	透過工作輸出中的路徑參照資產。
ReferenceType	列舉，以決定要用於資產的參考方法。
Sku	代表 SKU 的資源模型定義
SkuTier	如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。
systemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentity	使用者指派的身分識別屬性

BatchDeployment

Object

您可以使用特定屬性類型來建立具象追蹤的資源類型。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	受控服務識別（系統指派和/或使用者指派的身分識別）
kind	string	入口網站/工具等用來轉譯相同類型資源的不同UX體驗的元數據。
location	string	資源所在的地理位置
name	string	資源的名稱
properties	BatchDeploymentProperties	[必要]實體的其他屬性。
sku	Sku	自動調整之 ARM 合約所需的 SKU 詳細數據。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	資源標籤。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

BatchDeploymentConfigurationType

列舉型別

批次部署的列舉屬性類型。

值	Description
Model
PipelineComponent

BatchDeploymentProperties

Object

每個部署的批次推論設定。

名稱	類型	預設值	Description
codeConfiguration	CodeConfiguration		端點部署的程式代碼組態。
compute	string		批次推斷作業的計算目標。
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		與不同部署類型相關的屬性。
description	string		端點部署的描述。
environmentId	string		端點部署環境規格的 ARM 資源識別碼或 AssetId。
environmentVariables	object		部署的環境變數組態。
errorThreshold	integer (int32)	-1	錯誤閾值，如果整個輸入的錯誤計數超過此值，批次推論將會中止。範圍是 [-1， int。MaxValue]。針對 FileDataset，此值是檔案失敗的計數。針對 TabularDataset，此值是記錄失敗的計數。如果設定為 -1 （下限），則會忽略批次推斷期間的所有失敗。
loggingLevel	BatchLoggingLevel	Info	批次推斷的記錄詳細程度。記錄的詳細順序增加為：警告、資訊和偵錯。預設值為 Info。
maxConcurrencyPerInstance	integer (int32)	1	指出每個實例的平行處理原則數目上限。
miniBatchSize	integer (int64)	10	傳遞至每個批次調用的迷你批次大小。針對 FileDataset，這是每個迷你批次的檔案數目。針對 TabularDataset，這是每個迷你批次以位元組為單位的記錄大小。
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		端點部署的模型資產參考。
outputAction	BatchOutputAction	AppendRow	列舉，以決定批次推斷將如何處理輸出
outputFileName	string	predictions.csv	append_row輸出動作的自訂輸出檔名。
properties	object		屬性字典。可以新增屬性，但無法移除或改變。
provisioningState	DeploymentProvisioningState		端點部署的佈建狀態。
resources	DeploymentResourceConfiguration		指出作業的計算組態。如果未提供，則會預設為 ResourceConfiguration 中定義的預設值。
retrySettings	BatchRetrySettings		批次推斷作業的重試設定。如果未提供，則會預設為 BatchRetrySettings 中定義的預設值。

BatchDeploymentTrackedResourceArmPaginatedResult

Object

BatchDeployment 實體的編頁清單。

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	BatchDeployment[]	本頁的 BatchDeployment 項目

BatchLoggingLevel

列舉型別

批次推斷的記錄詳細程度。記錄的詳細順序增加為：警告、資訊和偵錯。預設值為 Info。

值	Description
Info
Warning
Debug

BatchOutputAction

列舉型別

列舉，以決定批次推斷將如何處理輸出

值	Description
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Object

批次管線元件部署的屬性。

名稱	類型	Description
componentId	IdAssetReference	要執行的元件的 ARM 識別碼。
deploymentConfigurationType	string: PipelineComponent	[必要]部署的類型
description	string	將套用至作業的描述。
settings	object	管線作業的運行時間設定。
tags	object	將套用至作業的標記。

BatchRetrySettings

Object

重試批次推論作業的設定。

名稱	類型	預設值	Description
maxRetries	integer (int32)	3	迷你批次的最大重試計數
timeout	string (duration)	PT30S	迷你批次的調用逾時，格式為 ISO 8601。

CodeConfiguration

Object

評分碼資產的配置。

名稱	類型	Description
codeId	string	程式代碼資產的 ARM 資源識別碼。
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[必要]在啟動時執行的腳本。 eg. "score.py"

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DataPathAssetReference

Object

透過資料存放區中的資產路徑參照資產。

名稱	類型	Description
datastoreId	string	資產所在數據存放區的 ARM 資源識別碼。
path	string	數據存放區中檔案/目錄的路徑。
referenceType	string: DataPath	[必要]指定資產參考的類型。

DeploymentProvisioningState

列舉型別

DeploymentProvisioningState 的可能值。

值	Description
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Object

名稱	類型	預設值	Description
instanceCount	integer (int32)	1	計算目標所使用的實例或節點選擇性數目。
instanceType	string		計算目標所支持的選擇性 VM 類型。
properties			其他屬性包。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

IdAssetReference

Object

透過資產的 ARM 資源識別碼參照資產。

名稱	類型	Description
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[必要]資產的 ARM 資源識別碼。
referenceType	string: Id	[必要]指定資產參考的類型。

ManagedServiceIdentity

Object

受控服務識別（系統指派和/或使用者指派的身分識別）

名稱	類型	Description
principalId	string (uuid)	系統指派身分識別的服務主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string (uuid)	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 身分識別與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 的字典鍵將是 ARM 資源 ID，形式為：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. 字典值可以是要求中的空白物件（{}）。

ManagedServiceIdentityType

列舉型別

受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。

值	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Object

透過工作輸出中的路徑參照資產。

名稱	類型	Description
jobId	string	作業的 ARM 資源識別碼。
path	string	作業輸出中檔案/目錄的路徑。
referenceType	string: OutputPath	[必要]指定資產參考的類型。

ReferenceType

列舉型別

列舉，以決定要用於資產的參考方法。

值	Description
Id
DataPath
OutputPath

Sku

Object

代表 SKU 的資源模型定義

名稱	類型	Description
capacity	integer (int32)	如果 SKU 支援相應放大/縮小，則應該包含容量整數。如果資源無法相應放大/縮小，可能會省略此專案。
family	string	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱。例如 - P3。通常是字母+數位碼
size	string	SKU 大小。當名稱欄位是階層和其他一些值的組合時，這會是獨立程序代碼。
tier	SkuTier	如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

SkuTier

列舉型別

如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

值	Description
Free
Basic
Standard
Premium

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserAssignedIdentity

Object

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string (uuid)	指派之身分識別的用戶端標識碼。
principalId	string (uuid)	指派之身分識別的主體標識碼。