Batch Deployments - Update

サービス:: Machine Learning

API バージョン:: 2025-06-01

バッチ推論のデプロイ (非同期) を更新します。

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

URI パラメーター

名前	/	必須	型	説明
deploymentName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	Batch 推論デプロイの識別子。
endpointName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	推論エンドポイント名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
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 バージョン。

要求本文

名前	型	説明
properties	PartialBatchDeployment	エンティティの追加の属性。
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	BatchDeploymentTrackedResource	成功
202 Accepted		受け入れられたヘッダー x-ms-async-operation-timeout: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	エラー

名前

型

説明

200 OK

BatchDeploymentTrackedResource

成功

202 Accepted

受け入れられた

ヘッダー

x-ms-async-operation-timeout: string
Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

エラー

例

Update Workspace Batch Deployment.

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments/testDeploymentName?api-version=2025-06-01

{
  "properties": {
    "description": "string"
  },
  "tags": {}
}

応答のサンプル

状態コード:: 200

Location: example_location

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "codeConfiguration": {
      "codeId": "string",
      "scoringScript": "string"
    },
    "environmentId": "string",
    "environmentVariables": {
      "string": "string"
    },
    "compute": "string",
    "errorThreshold": 1,
    "retrySettings": {
      "maxRetries": 1,
      "timeout": "PT5M"
    },
    "miniBatchSize": 1,
    "loggingLevel": "Info",
    "model": {
      "referenceType": "Id",
      "assetId": "string"
    },
    "maxConcurrencyPerInstance": 1,
    "outputAction": "SummaryOnly",
    "outputFileName": "string",
    "resources": {
      "instanceCount": 1,
      "instanceType": "string",
      "properties": {
        "string": {
          "1e5e1cf9-b0ea-4cf6-9764-e750bf85c10a": null
        }
      }
    },
    "provisioningState": "Creating"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "principalId": "00000000-1111-2222-3333-444444444444",
        "clientId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

状態コード:: 202

Location: example_location

定義

名前	説明
BatchDeployment	デプロイごとのバッチ推論設定。
BatchDeploymentConfigurationType	バッチ展開の列挙プロパティの種類。
BatchDeploymentTrackedResource
BatchLoggingLevel	バッチ推論のログ詳細度。ログ記録の詳細度の順序を増やすには、警告、情報、デバッグがあります。既定値は Info です。
BatchOutputAction	バッチ推論で出力がどのように処理されるかを決定する列挙型
BatchPipelineComponentDeploymentConfiguration	バッチパイプラインコンポーネントのデプロイのプロパティ。
BatchRetrySettings	バッチ推論操作の再試行設定。
CodeConfiguration	スコアリングコード資産の構成。
createdByType	リソースを作成した ID の種類。
DataPathAssetReference	データストア内のパスを介した資産への参照。
DeploymentProvisioningState	DeploymentProvisioningState に指定できる値。
DeploymentResourceConfiguration
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IdAssetReference	ARM リソース ID を介した資産への参照。
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
OutputPathAssetReference	ジョブ出力内のパスを介した資産への参照。
PartialBatchDeployment	デプロイごとの変更可能なバッチ推論設定。
PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties	更新要求で厳密に使用されます。
ReferenceType	資産に使用する参照メソッドを決定する列挙型。
Sku	SKU を表すリソースモデル定義
SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

BatchDeployment

Object

デプロイごとのバッチ推論設定。

名前	型	規定値	説明
codeConfiguration	CodeConfiguration		エンドポイントデプロイのコード構成。
compute	string		バッチ推論操作のコンピューティング先。
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		さまざまな展開の種類に関連するプロパティ。
description	string		エンドポイントのデプロイの説明。
environmentId	string		エンドポイントデプロイの環境仕様の ARM リソース ID または AssetId。
environmentVariables	object		デプロイの環境変数の構成。
errorThreshold	integer (int32)	-1	エラーしきい値。入力全体のエラー数がこの値を超えた場合、バッチ推論は中止されます。範囲は [-1, int] です。MaxValue]。 FileDataset の場合、この値はファイルエラーの数です。 TabularDataset の場合、この値はレコードエラーの数です。 -1 (下限) に設定すると、バッチ推論中のすべてのエラーは無視されます。
loggingLevel	BatchLoggingLevel	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 で定義されている既定値になります。

BatchDeploymentConfigurationType

列挙

バッチ展開の列挙プロパティの種類。

値	説明
Model
PipelineComponent

BatchDeploymentTrackedResource

Object

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
kind	string	同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータルやツールなどで使用されるメタデータ。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties	BatchDeployment	[必須]エンティティの追加の属性。
sku	Sku	自動スケールの ARM コントラクトに必要な SKU の詳細。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BatchLoggingLevel

列挙

バッチ推論のログ詳細度。ログ記録の詳細度の順序を増やすには、警告、情報、デバッグがあります。既定値は Info です。

値	説明
Debug
Info
Warning

BatchOutputAction

列挙

バッチ推論で出力がどのように処理されるかを決定する列挙型

値	説明
AppendRow
SummaryOnly

BatchPipelineComponentDeploymentConfiguration

Object

バッチパイプラインコンポーネントのデプロイのプロパティ。

名前	型	説明
componentId	IdAssetReference	実行するコンポーネントの ARM ID。
deploymentConfigurationType	string: PipelineComponent	[必須]デプロイの種類
description	string	ジョブに適用される説明。
settings	object	パイプラインジョブの実行時設定。
tags	object	ジョブに適用されるタグ。

BatchRetrySettings

Object

バッチ推論操作の再試行設定。

名前	型	規定値	説明
maxRetries	integer (int32)	3	ミニバッチの最大再試行回数
timeout	string (duration)	PT30S	ISO 8601 形式のミニバッチの呼び出しタイムアウト。

CodeConfiguration

Object

スコアリングコード資産の構成。

名前	型	説明
codeId	string	コード資産の ARM リソース ID。
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[必須]起動時に実行するスクリプト。例えば。「score.py」

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DataPathAssetReference

Object

データストア内のパスを介した資産への参照。

名前	型	説明
datastoreId	string	資産が配置されているデータストアの ARM リソース ID。
path	string	データストア内のファイル/ディレクトリのパス。
referenceType	string: DataPath	[必須]資産参照の種類を指定します。

DeploymentProvisioningState

列挙

DeploymentProvisioningState に指定できる値。

値	説明
Canceled
Creating
Deleting
Failed
Scaling
Succeeded
Updating

DeploymentResourceConfiguration

Object

名前	型	規定値	説明
instanceCount	integer (int32)	1	コンピューティング先で使用されるインスタンスまたはノードの数 (省略可能)。
instanceType	string		コンピューティング先でサポートされている VM のオプションの種類。
properties	object		追加のプロパティバッグ。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

IdAssetReference

Object

ARM リソース ID を介した資産への参照。

名前	型	説明
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[必須]資産の ARM リソース ID。
referenceType	string: Id	[必須]資産参照の種類を指定します。

ManagedServiceIdentity

Object

マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

OutputPathAssetReference

Object

ジョブ出力内のパスを介した資産への参照。

名前	型	説明
jobId	string	ジョブの ARM リソース ID。
path	string	ジョブ出力内のファイル/ディレクトリのパス。
referenceType	string: OutputPath	[必須]資産参照の種類を指定します。

PartialBatchDeployment

Object

デプロイごとの変更可能なバッチ推論設定。

名前	型	説明
description	string	エンドポイントのデプロイの説明。

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

Object

更新要求で厳密に使用されます。

名前	型	説明
properties	PartialBatchDeployment	エンティティの追加の属性。
tags	object	リソースタグ。

ReferenceType

列挙

資産に使用する参照メソッドを決定する列挙型。

値	説明
DataPath
Id
OutputPath

Sku

Object

SKU を表すリソースモデル定義

名前	型	説明
capacity	integer (int32)	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前。例 - P3。通常は文字 + 数字のコードです
size	string	SKU サイズ。名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロンコードになります。
tier	SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。

SkuTier

列挙

このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。

値	説明
Basic
Free
Premium
Standard

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。

次の方法で共有

Batch Deployments - Update

URI パラメーター

要求本文

応答

例

Update Workspace Batch Deployment.

要求のサンプル

応答のサンプル

定義

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentTrackedResource

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

PartialBatchDeployment

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity