次の方法で共有


Batch Deployments - List

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

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

URI パラメーター

名前 / 必須 説明
endpointName
path True

string

エンドポイント名

resourceGroupName
path True

string

リソース グループの名前。 名前では大文字と小文字が区別されません。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

workspaceName
path True

string

Azure Machine Learning ワークスペースの名前。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

この操作に使用する API バージョン。

$orderBy
query

string

リストの順序。

$skip
query

string

改ページ位置の継続トークン。

$top
query

integer

int32

リストの先頭。

応答

名前 説明
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

成功

Other Status Codes

ErrorResponse

エラー

List Workspace Batch Deployment.

要求のサンプル

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

応答のサンプル

{
  "value": [
    {
      "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": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": 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
      }
    }
  ],
  "nextLink": "string"
}

定義

名前 説明
BatchDeployment

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

BatchDeploymentConfigurationType

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

BatchDeploymentTrackedResource
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

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

名前 規定値 説明
codeConfiguration

CodeConfiguration

エンドポイントデプロイのコード構成。

compute

string

バッチ推論操作のコンピューティング 先。

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

さまざまな展開の種類に関連するプロパティ。

description

string

エンドポイントのデプロイの説明。

environmentId

string

エンドポイントデプロイの環境仕様の ARM リソース ID または AssetId。

environmentVariables

object

デプロイの環境変数の構成。

errorThreshold

integer

-1

エラーしきい値。入力全体のエラー数がこの値を超えた場合、バッチ推論は中止されます。 範囲は [-1, int] です。MaxValue]。 FileDataset の場合、この値はファイルエラーの数です。 TabularDataset の場合、この値はレコードエラーの数です。 -1 (下限) に設定すると、バッチ推論中のすべてのエラーは無視されます。

loggingLevel

BatchLoggingLevel

Info

バッチ推論操作のログ 記録レベル。

maxConcurrencyPerInstance

integer

1

インスタンスあたりの並列処理の最大数を示します。

miniBatchSize

integer

10

各バッチ呼び出しに渡されるミニ バッチのサイズ。 FileDataset の場合、これはミニバッチあたりのファイルの数です。 TabularDataset の場合、これはミニ バッチごとのレコードのサイズ (バイト単位) です。

model AssetReferenceBase:

エンドポイントデプロイのモデル資産への参照。

outputAction

BatchOutputAction

AppendRow

出力の編成方法を示します。

outputFileName

string

predictions.csv

append_row出力アクションのカスタマイズされた出力ファイル名。

properties

object

プロパティ ディクショナリ。 プロパティは追加できますが、削除または変更することはできません。

provisioningState

DeploymentProvisioningState

エンドポイントデプロイのプロビジョニング状態。

resources

DeploymentResourceConfiguration

ジョブのコンピューティング構成を示します。 指定しない場合、ResourceConfiguration で定義されている既定値が既定値になります。

retrySettings

BatchRetrySettings

バッチ推論操作の再試行設定。 指定しない場合、既定では BatchRetrySettings で定義されている既定値になります。

BatchDeploymentConfigurationType

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

名前 説明
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

名前 説明
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"

BatchDeploymentTrackedResourceArmPaginatedResult

BatchDeployment エンティティのページ分割されたリスト。

名前 説明
nextLink

string

BatchDeployment オブジェクトの次のページへのリンク。 null の場合、追加のページはありません。

value

BatchDeploymentTrackedResource[]

BatchDeployment 型のオブジェクトの配列。

BatchLoggingLevel

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

名前 説明
Debug

string

Info

string

Warning

string

BatchOutputAction

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

名前 説明
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

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

名前 説明
componentId

IdAssetReference

実行するコンポーネントの ARM ID。

deploymentConfigurationType string:

PipelineComponent

[必須]デプロイの種類

description

string

ジョブに適用される説明。

settings

object

パイプライン ジョブの実行時設定。

tags

object

ジョブに適用されるタグ。

BatchRetrySettings

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

名前 規定値 説明
maxRetries

integer

3

ミニバッチの最大再試行回数

timeout

string

PT30S

ISO 8601 形式のミニ バッチの呼び出しタイムアウト。

CodeConfiguration

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

名前 説明
codeId

string

コード資産の ARM リソース ID。

scoringScript

string

[必須]起動時に実行するスクリプト。 例えば。 "score.py"

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

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

名前 説明
datastoreId

string

資産が配置されているデータストアの ARM リソース ID。

path

string

データストア内のファイル/ディレクトリのパス。

referenceType string:

DataPath

[必須]資産参照の種類を指定します。

DeploymentProvisioningState

DeploymentProvisioningState に指定できる値。

名前 説明
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

名前 規定値 説明
instanceCount

integer

1

コンピューティング 先で使用されるインスタンスまたはノードの数 (省略可能)。

instanceType

string

コンピューティング 先でサポートされている VM のオプションの種類。

properties

object

追加のプロパティ バッグ。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

IdAssetReference

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

名前 説明
assetId

string

[必須]資産の ARM リソース ID。

referenceType string:

Id

[必須]資産参照の種類を指定します。

ManagedServiceIdentity

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

名前 説明
principalId

string

システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。

tenantId

string

システム割り当て 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

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

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

名前 説明
jobId

string

ジョブの ARM リソース ID。

path

string

ジョブ出力内のファイル/ディレクトリのパス。

referenceType string:

OutputPath

[必須]資産参照の種類を指定します。

ReferenceType

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

名前 説明
DataPath

string

Id

string

OutputPath

string

Sku

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

名前 説明
capacity

integer

SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。

family

string

同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。

name

string

SKU の名前。 例 - P3。 通常は文字 + 数字のコードです

size

string

SKU サイズ。 名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロン コードになります。

tier

SkuTier

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

SkuTier

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

名前 説明
Basic

string

Free

string

Premium

string

Standard

string

systemData

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

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

UserAssignedIdentity

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

名前 説明
clientId

string

割り当てられた ID のクライアント ID。

principalId

string

割り当てられた ID のプリンシパル ID。