Batch Deployments - List

サービス:: Machine Learning

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

ワークスペース内のバッチ推論デプロイを一覧表示します。

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

省略可能なパラメーターを含む:

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 パラメーター

名前	/	必須	型	説明
endpointName	path	True	string	Batch エンドポイントの名前。
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 バージョン。
$orderBy	query		string	リストの順序。
$skip	query		string	改ページ位置の継続トークン。
$top	query		integer (int32)	リストの先頭。

応答

名前	型	説明
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Azure 操作は正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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=2025-12-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": {}
    }
  ]
}

定義

名前	説明
BatchDeployment	具体的な追跡対象リソースの種類は、特定のプロパティ型を使用してこの型にエイリアスを設定することで作成できます。
BatchDeploymentConfigurationType	バッチデプロイの列挙されたプロパティの種類。
BatchDeploymentProperties	デプロイごとのバッチ推論設定。
BatchDeploymentTrackedResourceArmPaginatedResult	BatchDeployment エンティティのページ分割されたリスト。
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	ジョブ出力内のパスを介したアセットへの参照。
ReferenceType	アセットに使用する参照方法を決定する列挙型。
Sku	SKU を表すリソースモデル定義
SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

BatchDeployment

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	BatchDeploymentProperties	[必須]エンティティの追加の属性。
sku	Sku	自動スケールの ARM コントラクトに必要な SKU の詳細。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BatchDeploymentConfigurationType

列挙

バッチデプロイの列挙されたプロパティの種類。

値	説明
Model
PipelineComponent

BatchDeploymentProperties

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	バッチ推論のログ詳細性。ログの詳細な順序を上げると、警告、情報、デバッグになります。既定値は 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 エンティティのページ分割されたリスト。

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	BatchDeployment[]	このページのバッチデプロイメント項目

BatchLoggingLevel

列挙

バッチ推論のログ詳細性。ログの詳細な順序を上げると、警告、情報、デバッグになります。既定値は Info です。

値	説明
Info
Warning
Debug

BatchOutputAction

列挙

バッチ推論が出力を処理する方法を決定する列挙型

値	説明
SummaryOnly
AppendRow

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_]	[必須]起動時に実行するスクリプト。 eg. "score.py"

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

DataPathAssetReference

Object

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

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

DeploymentProvisioningState

列挙

DeploymentProvisioningState に指定できる値。

値	説明
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Object

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

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
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Object

ジョブ出力内のパスを介したアセットへの参照。

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

ReferenceType

列挙

アセットに使用する参照方法を決定する列挙型。

値	説明
Id
DataPath
OutputPath

Sku

Object

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

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

SkuTier

列挙

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

値	説明
Free
Basic
Standard
Premium

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 - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

List Workspace Batch Deployment.

要求のサンプル

応答のサンプル

定義

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