Batch Deployments - List

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

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

URI パラメーター

Name In Required Type Description
endpointName
path True
  • string

エンドポイント名

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

workspaceName
path True
  • string

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

api-version
query True
  • string

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

$orderBy
query
  • string

リストの順序。

$skip
query
  • string

ページ割り当ての継続トークン。

$top
query
  • integer
int32

リストの先頭。

応答

Name Type Description
200 OK

Success

Other Status Codes

エラー

List Batch Deployment.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/testBatchEndpoint/deployments?api-version=2021-03-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/testBatchEndpoint/deployments/testBatchDeployment",
      "name": "testBatchDeployment",
      "type": "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments",
      "tags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": {
            "clientId": "string"
          }
        }
      },
      "properties": {
        "compute": {
          "target": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/testcompute",
          "instanceCount": 0,
          "isLocal": false,
          "location": "string",
          "instanceType": "string",
          "properties": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        },
        "errorThreshold": 0,
        "retrySettings": {
          "maxRetries": 0,
          "timeout": "string"
        },
        "partitionKeys": [
          "string"
        ],
        "miniBatchSize": 0,
        "loggingLevel": "Info",
        "outputConfiguration": {
          "outputAction": "SummaryOnly",
          "appendRowFileName": "string"
        },
        "description": "string",
        "properties": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "model": {
          "referenceType": "Id",
          "assetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/models/testmodel/versions/1"
        },
        "codeConfiguration": {
          "codeId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testcode/versions/1",
          "scoringScript": "score.py"
        },
        "environmentId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/myenv",
        "environmentVariables": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      },
      "systemData": {
        "createdAt": "2021-03-25T20:46:47.062Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2021-03-25T20:46:47.062Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      }
    }
  ],
  "nextLink": "string"
}

定義

BatchDeployment

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

BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult

バッチ展開エンティティの改ページ調整された一覧。

BatchLoggingLevel

Batch 推論のログの詳細度。 ログ記録の詳細度を上げるには、警告、情報、デバッグの順にします。 既定値は [情報] です。

BatchOutputAction

バッチのインフェレンシングが出力を処理する方法を決定する列挙型

BatchOutputConfiguration

バッチ推論の出力構成。

BatchRetrySettings

バッチ推論操作の設定を再試行します。

CodeConfiguration

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

ComputeConfiguration

コンピューティングバインドの構成。

createdByType

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

DataPathAssetReference

データストア内のパスを使用して資産を参照します。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

IdAssetReference

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

OutputPathAssetReference

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

ReferenceType

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

ResourceIdentity

リソースに関連付けられているサービス id。

ResourceIdentityAssignment

ResourceIdentity の型の値を定義します。

systemData

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

UserAssignedIdentityMeta

リソースに関連付けられているユーザー割り当て id。

BatchDeployment

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

Name Type Description
codeConfiguration

エンドポイント展開のコード構成。

compute

コンピューティングバインドの構成。

description
  • string

エンドポイント展開の説明。

environmentId
  • string

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

environmentVariables
  • object

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

errorThreshold
  • integer

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

loggingLevel

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

miniBatchSize
  • integer

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

model AssetReferenceBase:

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

outputConfiguration

バッチ推論操作の出力構成。

partitionKeys
  • string[]

名前付きパーティション分割に使用されるパーティションキーの一覧。

properties
  • object

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

retrySettings

バッチ推論操作の設定を再試行してください。

BatchDeploymentTrackedResource

Name Type Description
id
  • string

リソースの完全修飾リソース ID。 例-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

リソースに関連付けられているサービス id。

kind
  • string

ポータルやツールなどによって使用されるメタデータは、同じ種類のリソースに対してさまざまな UX エクスペリエンスをレンダリングします。

location
  • string

リソースが存在する地理的な場所

name
  • string

リソースの名前

properties

エンティティの追加属性。

systemData

リソースプロバイダーに関連付けられているシステムデータ

tags
  • object

リソース タグ。

type
  • string

リソースの型。 例: "Microsoft. Compute/virtualMachines" または "Microsoft.Storage/storageaccounts "

BatchDeploymentTrackedResourceArmPaginatedResult

バッチ展開エンティティの改ページ調整された一覧。

Name Type Description
nextLink
  • string

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

value

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

BatchLoggingLevel

Batch 推論のログの詳細度。 ログ記録の詳細度を上げるには、警告、情報、デバッグの順にします。 既定値は [情報] です。

Name Type Description
Debug
  • string
Info
  • string
Warning
  • string

BatchOutputAction

バッチのインフェレンシングが出力を処理する方法を決定する列挙型

Name Type Description
AppendRow
  • string
SummaryOnly
  • string

BatchOutputConfiguration

バッチ推論の出力構成。

Name Type Description
appendRowFileName
  • string

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

outputAction

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

BatchRetrySettings

バッチ推論操作の設定を再試行します。

Name Type Description
maxRetries
  • integer

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

timeout
  • string

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

CodeConfiguration

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

Name Type Description
codeId
  • string

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

scoringScript
  • string

起動時に実行するスクリプトです。 例: "score.py"

ComputeConfiguration

コンピューティングバインドの構成。

Name Type Description
instanceCount
  • integer

インスタンスまたはノードの数。

instanceType
  • string

実行する SKU の種類。

isLocal
  • boolean

ローカルコンピューティングで実行されているジョブの場合は true に設定します。

location
  • string

仮想クラスターの実行場所。

properties
  • object

追加のプロパティ。

target
  • string

コンピューティングリソースの ARM リソース ID。

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataPathAssetReference

データストア内のパスを使用して資産を参照します。

Name Type Description
datastoreId
  • string

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

path
  • string

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

referenceType string:
  • DataPath

資産参照の種類を指定します。

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラーオブジェクト。

IdAssetReference

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

Name Type Description
assetId
  • string

資産の ARM リソース ID。

referenceType string:
  • Id

資産参照の種類を指定します。

OutputPathAssetReference

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

Name Type Description
jobId
  • string

ジョブの ARM リソース ID。

path
  • string

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

referenceType string:
  • OutputPath

資産参照の種類を指定します。

ReferenceType

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

Name Type Description
DataPath
  • string
Id
  • string
OutputPath
  • string

ResourceIdentity

リソースに関連付けられているサービス id。

Name Type Description
principalId
  • string

認証時に使用されるクライアント ID。

tenantId
  • string

この id が存在する AAD テナント。

type

ResourceIdentity の型の値を定義します。

userAssignedIdentities

ユーザーが割り当てられた id のディクショナリ、キーは UAI の ARM リソース ID です。

ResourceIdentityAssignment

ResourceIdentity の型の値を定義します。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

systemData

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

Name Type Description
createdAt
  • string

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

createdBy
  • string

リソースを作成した id。

createdByType

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

lastModifiedAt
  • string

リソースの最終変更日時 (UTC)

lastModifiedBy
  • string

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

lastModifiedByType

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

UserAssignedIdentityMeta

リソースに関連付けられているユーザー割り当て id。

Name Type Description
clientId
  • string

アプリケーション ID は、初期プロビジョニング中にアプリケーションとサービスプリンシパルに関連付けられた Azure AD によって生成される一意の識別子です。

principalId
  • string

Azure リソースへのロールベースのアクセスを許可するために使用される、管理対象 id のサービスプリンシパルオブジェクトのオブジェクト ID。