Share via


Microsoft.MachineLearningServices ワークスペース/batchEndpoints/deployments 2021-03-01-preview

Bicep リソース定義

workspaces/batchEndpoints/deployments リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    codeConfiguration: {
      codeId: 'string'
      scoringScript: 'string'
    }
    compute: {
      instanceCount: int
      instanceType: 'string'
      isLocal: bool
      location: 'string'
      properties: {
        {customized property}: 'string'
      }
      target: 'string'
    }
    description: 'string'
    environmentId: 'string'
    environmentVariables: {
      {customized property}: 'string'
    }
    errorThreshold: int
    loggingLevel: 'string'
    miniBatchSize: int
    model: {
      referenceType: 'string'
      // For remaining properties, see AssetReferenceBase objects
    }
    outputConfiguration: {
      appendRowFileName: 'string'
      outputAction: 'string'
    }
    partitionKeys: [
      'string'
    ]
    properties: {
      {customized property}: 'string'
    }
    retrySettings: {
      maxRetries: int
      timeout: 'string'
    }
  }
}

AssetReferenceBase オブジェクト

referenceType プロパティを設定して、オブジェクトの種類を指定します。

DataPath の場合は、次の値を使用します。

  referenceType: 'DataPath'
  datastoreId: 'string'
  path: 'string'

[ID] には、次の値を使用します。

  referenceType: 'Id'
  assetId: 'string'

OutputPath の場合は、次を使用します。

  referenceType: 'OutputPath'
  jobId: 'string'
  path: 'string'

プロパティ値

workspaces/batchEndpoints/deployments

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。 string
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: batchEndpoints
identity リソースに関連付けられているサービス ID。 ResourceIdentity
properties [必須]エンティティの追加の属性。 BatchDeployment (必須)

ResourceIdentity

名前 説明
type ResourceIdentity の型の値を定義します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のディクショナリ。キーは UAI の ARM リソース ID です。 ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityMeta

UserAssignedIdentityMeta

名前 説明
clientId 別名アプリケーション ID。Azure AD によって生成され、初期プロビジョニング中にアプリケーションとサービス プリンシパルに関連付けられている一意の識別子です。 string
principalId Azure リソースへのロールベースのアクセスを許可するために使用されるマネージド ID のサービス プリンシパル オブジェクトのオブジェクト ID。 string

BatchDeployment

名前 説明
codeConfiguration エンドポイントデプロイのコード構成。 CodeConfiguration
compute コンピューティング バインディングの構成。 ComputeConfiguration
description エンドポイントのデプロイの説明。 string
environmentId エンドポイントデプロイの環境仕様の ARM リソース ID。 string
environmentVariables デプロイの環境変数の構成。 BatchDeploymentEnvironmentVariables
errorThreshold エラーしきい値(入力全体のエラー数がこの値を超える場合)
バッチ推論は中止されます。 範囲は [-1, int.MaxValue]。
FileDataset の場合、この値はファイルエラーの数です。
TabularDataset の場合、この値はレコードエラーの数です。
-1 (下限) に設定すると、バッチ推論中のすべてのエラーは無視されます。
INT
loggingLevel バッチ推論操作のログ レベル。 'Debug'
'Info'
'警告'
miniBatchSize 各バッチ呼び出しに渡されるミニバッチのサイズ。
FileDataset の場合、これはミニバッチあたりのファイルの数です。
TabularDataset の場合、これはミニバッチごとのレコードのサイズ (バイト単位) です。
INT
model エンドポイント デプロイのモデル資産への参照。 AssetReferenceBase
outputConfiguration バッチ推論操作の出力構成。 BatchOutputConfiguration
partitionKeys 名前付きパーティション分割に使用されるパーティション キーの一覧。 string[]
properties プロパティ ディクショナリ。 プロパティは追加できますが、削除または変更することはできません。 BatchDeploymentProperties
retrySettings バッチ推論操作の再試行設定。 BatchRetrySettings

CodeConfiguration

名前 説明
codeId コード資産の ARM リソース ID。 string
scoringScript [必須]起動時に実行するスクリプト。 例: "score.py" string (必須)

制約:
最小長 = 1
Pattern = [a-zA-Z0-9_]

ComputeConfiguration

名前 説明
instanceCount インスタンスまたはノードの数。 INT
instanceType 実行する SKU の種類。 string
isLocal ローカル コンピューティングで実行されているジョブの場合は true に設定します。 [bool]
location 仮想クラスターの実行の場所。 string
properties その他のプロパティ。 ComputeConfigurationProperties
ターゲット (target) ターゲットとするコンピューティングの ARM リソース ID。 指定されていない場合、リソースはマネージドとしてデプロイされます。 string

ComputeConfigurationProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchDeploymentEnvironmentVariables

名前 説明
{カスタマイズされたプロパティ} string

AssetReferenceBase

名前 説明
referenceType オブジェクトの種類を設定する DataPath
Id
OutputPath (必須)

DataPathAssetReference

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

IdAssetReference

名前 説明
referenceType [必須]資産参照の種類を指定します。 'Id' (必須)
assetId [必須]資産の ARM リソース ID。 string (必須)

制約:
Pattern = [a-zA-Z0-9_]

OutputPathAssetReference

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

BatchOutputConfiguration

名前 説明
appendRowFileName append_row出力アクションのカスタマイズされた出力ファイル名。 string
outputAction 出力の編成方法を示します。 'AppendRow'
'SummaryOnly'

BatchDeploymentProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchRetrySettings

名前 説明
maxRetries ミニバッチの最大再試行回数 INT
timeout ISO 8601 形式のミニバッチの呼び出しタイムアウト。 string

ARM テンプレート リソース定義

workspaces/batchEndpoints/deployments リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "codeConfiguration": {
      "codeId": "string",
      "scoringScript": "string"
    },
    "compute": {
      "instanceCount": "int",
      "instanceType": "string",
      "isLocal": "bool",
      "location": "string",
      "properties": {
        "{customized property}": "string"
      },
      "target": "string"
    },
    "description": "string",
    "environmentId": "string",
    "environmentVariables": {
      "{customized property}": "string"
    },
    "errorThreshold": "int",
    "loggingLevel": "string",
    "miniBatchSize": "int",
    "model": {
      "referenceType": "string"
      // For remaining properties, see AssetReferenceBase objects
    },
    "outputConfiguration": {
      "appendRowFileName": "string",
      "outputAction": "string"
    },
    "partitionKeys": [ "string" ],
    "properties": {
      "{customized property}": "string"
    },
    "retrySettings": {
      "maxRetries": "int",
      "timeout": "string"
    }
  }
}

AssetReferenceBase オブジェクト

referenceType プロパティを設定して、オブジェクトの種類を指定します。

DataPath の場合は、次の値を使用します。

  "referenceType": "DataPath",
  "datastoreId": "string",
  "path": "string"

[ID] には、次の値を使用します。

  "referenceType": "Id",
  "assetId": "string"

OutputPath の場合は、次を使用します。

  "referenceType": "OutputPath",
  "jobId": "string",
  "path": "string"

プロパティ値

workspaces/batchEndpoints/deployments

名前 説明
type リソースの種類 'Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments'
apiVersion リソース API のバージョン '2021-03-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。 string
identity リソースに関連付けられているサービス ID。 ResourceIdentity
properties [必須]エンティティの追加の属性。 BatchDeployment (必須)

ResourceIdentity

名前 説明
type ResourceIdentity の型の値を定義します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のディクショナリ。キーは UAI の ARM リソース ID です。 ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityMeta

UserAssignedIdentityMeta

名前 説明
clientId 別名アプリケーション ID。Azure AD によって生成され、初期プロビジョニング中にアプリケーションとサービス プリンシパルに関連付けられている一意の識別子です。 string
principalId Azure リソースへのロールベースのアクセスを許可するために使用されるマネージド ID のサービス プリンシパル オブジェクトのオブジェクト ID。 string

BatchDeployment

名前 説明
codeConfiguration エンドポイントデプロイのコード構成。 CodeConfiguration
compute コンピューティング バインディングの構成。 ComputeConfiguration
description エンドポイントのデプロイの説明。 string
environmentId エンドポイントデプロイの環境仕様の ARM リソース ID。 string
environmentVariables デプロイの環境変数の構成。 BatchDeploymentEnvironmentVariables
errorThreshold エラーしきい値(入力全体のエラー数がこの値を超える場合)
バッチ推論は中止されます。 範囲は [-1, int.MaxValue]。
FileDataset の場合、この値はファイルエラーの数です。
TabularDataset の場合、この値はレコードエラーの数です。
-1 (下限) に設定すると、バッチ推論中のすべてのエラーは無視されます。
INT
loggingLevel バッチ推論操作のログ レベル。 'Debug'
'Info'
'警告'
miniBatchSize 各バッチ呼び出しに渡されるミニバッチのサイズ。
FileDataset の場合、これはミニバッチあたりのファイルの数です。
TabularDataset の場合、これはミニバッチごとのレコードのサイズ (バイト単位) です。
INT
model エンドポイント デプロイのモデル資産への参照。 AssetReferenceBase
outputConfiguration バッチ推論操作の出力構成。 BatchOutputConfiguration
partitionKeys 名前付きパーティション分割に使用されるパーティション キーの一覧。 string[]
properties プロパティ ディクショナリ。 プロパティは追加できますが、削除または変更することはできません。 BatchDeploymentProperties
retrySettings バッチ推論操作の再試行設定。 BatchRetrySettings

CodeConfiguration

名前 説明
codeId コード資産の ARM リソース ID。 string
scoringScript [必須]起動時に実行するスクリプト。 例: "score.py" string (必須)

制約:
最小長 = 1
Pattern = [a-zA-Z0-9_]

ComputeConfiguration

名前 説明
instanceCount インスタンスまたはノードの数。 INT
instanceType 実行する SKU の種類。 string
isLocal ローカル コンピューティングで実行されているジョブの場合は true に設定します。 [bool]
location 仮想クラスターの実行の場所。 string
properties その他のプロパティ。 ComputeConfigurationProperties
ターゲット (target) ターゲットとするコンピューティングの ARM リソース ID。 指定されていない場合、リソースはマネージドとしてデプロイされます。 string

ComputeConfigurationProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchDeploymentEnvironmentVariables

名前 説明
{カスタマイズされたプロパティ} string

AssetReferenceBase

名前 説明
referenceType オブジェクトの種類を設定する DataPath
Id
OutputPath (必須)

DataPathAssetReference

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

IdAssetReference

名前 説明
referenceType [必須]資産参照の種類を指定します。 'Id' (必須)
assetId [必須]資産の ARM リソース ID。 string (必須)

制約:
Pattern = [a-zA-Z0-9_]

OutputPathAssetReference

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

BatchOutputConfiguration

名前 説明
appendRowFileName append_row出力アクションのカスタマイズされた出力ファイル名。 string
outputAction 出力の編成方法を示します。 'AppendRow'
'SummaryOnly'

BatchDeploymentProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchRetrySettings

名前 説明
maxRetries ミニバッチの最大再試行回数 INT
timeout ISO 8601 形式のミニバッチの呼び出しタイムアウト。 string

Terraform (AzAPI プロバイダー) リソース定義

workspaces/batchEndpoints/deployments リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      codeConfiguration = {
        codeId = "string"
        scoringScript = "string"
      }
      compute = {
        instanceCount = int
        instanceType = "string"
        isLocal = bool
        location = "string"
        properties = {
          {customized property} = "string"
        }
        target = "string"
      }
      description = "string"
      environmentId = "string"
      environmentVariables = {
        {customized property} = "string"
      }
      errorThreshold = int
      loggingLevel = "string"
      miniBatchSize = int
      model = {
        referenceType = "string"
        // For remaining properties, see AssetReferenceBase objects
      }
      outputConfiguration = {
        appendRowFileName = "string"
        outputAction = "string"
      }
      partitionKeys = [
        "string"
      ]
      properties = {
        {customized property} = "string"
      }
      retrySettings = {
        maxRetries = int
        timeout = "string"
      }
    }
    kind = "string"
  })
}

AssetReferenceBase オブジェクト

referenceType プロパティを設定して、オブジェクトの種類を指定します。

DataPath の場合は、次の値を使用します。

  referenceType = "DataPath"
  datastoreId = "string"
  path = "string"

[ID] には、次の値を使用します。

  referenceType = "Id"
  assetId = "string"

OutputPath の場合は、次を使用します。

  referenceType = "OutputPath"
  jobId = "string"
  path = "string"

プロパティ値

workspaces/batchEndpoints/deployments

名前 説明
type リソースの種類 "Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview"
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: batchEndpoints
tags リソース タグ。 タグ名と値のディクショナリ。
kind 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。 string
identity リソースに関連付けられているサービス ID。 ResourceIdentity
properties [必須]エンティティの追加の属性。 BatchDeployment (必須)

ResourceIdentity

名前 説明
type ResourceIdentity の型の値を定義します。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids ユーザー割り当て ID のディクショナリ。キーは UAI の ARM リソース ID です。 ユーザー ID ID の配列。

ResourceIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityMeta

UserAssignedIdentityMeta

名前 説明
clientId 別名アプリケーション ID。Azure AD によって生成され、初期プロビジョニング中にアプリケーションとサービス プリンシパルに関連付けられている一意の識別子です。 string
principalId Azure リソースへのロールベースのアクセスを許可するために使用されるマネージド ID のサービス プリンシパル オブジェクトのオブジェクト ID。 string

BatchDeployment

名前 説明
codeConfiguration エンドポイントデプロイのコード構成。 CodeConfiguration
compute コンピューティング バインディングの構成。 ComputeConfiguration
description エンドポイントのデプロイの説明。 string
environmentId エンドポイントデプロイの環境仕様の ARM リソース ID。 string
environmentVariables デプロイの環境変数の構成。 BatchDeploymentEnvironmentVariables
errorThreshold エラーしきい値(入力全体のエラー数がこの値を超える場合)
バッチ推論は中止されます。 範囲は [-1, int.MaxValue]。
FileDataset の場合、この値はファイルエラーの数です。
TabularDataset の場合、この値はレコードエラーの数です。
-1 (下限) に設定すると、バッチ推論中のすべてのエラーは無視されます。
INT
loggingLevel バッチ推論操作のログ レベル。 "デバッグ"
"情報"
"Warning"
miniBatchSize 各バッチ呼び出しに渡されるミニバッチのサイズ。
FileDataset の場合、これはミニバッチあたりのファイルの数です。
TabularDataset の場合、これはミニバッチごとのレコードのサイズ (バイト単位) です。
INT
model エンドポイント デプロイのモデル資産への参照。 AssetReferenceBase
outputConfiguration バッチ推論操作の出力構成。 BatchOutputConfiguration
partitionKeys 名前付きパーティション分割に使用されるパーティション キーの一覧。 string[]
properties プロパティ ディクショナリ。 プロパティは追加できますが、削除または変更することはできません。 BatchDeploymentProperties
retrySettings バッチ推論操作の再試行設定。 BatchRetrySettings

CodeConfiguration

名前 説明
codeId コード資産の ARM リソース ID。 string
scoringScript [必須]起動時に実行するスクリプト。 例: "score.py" string (必須)

制約:
最小長 = 1
Pattern = [a-zA-Z0-9_]

ComputeConfiguration

名前 説明
instanceCount インスタンスまたはノードの数。 INT
instanceType 実行する SKU の種類。 string
isLocal ローカル コンピューティングで実行されているジョブの場合は true に設定します。 [bool]
location 仮想クラスターの実行の場所。 string
properties その他のプロパティ。 ComputeConfigurationProperties
ターゲット (target) ターゲットとするコンピューティングの ARM リソース ID。 指定されていない場合、リソースはマネージドとしてデプロイされます。 string

ComputeConfigurationProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchDeploymentEnvironmentVariables

名前 説明
{カスタマイズされたプロパティ} string

AssetReferenceBase

名前 説明
referenceType オブジェクトの種類を設定する DataPath
Id
OutputPath (必須)

DataPathAssetReference

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

IdAssetReference

名前 説明
referenceType [必須]資産参照の種類を指定します。 "Id" (必須)
assetId [必須]資産の ARM リソース ID。 string (必須)

制約:
Pattern = [a-zA-Z0-9_]

OutputPathAssetReference

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

BatchOutputConfiguration

名前 説明
appendRowFileName append_row出力アクションのカスタマイズされた出力ファイル名。 string
outputAction 出力の編成方法を示します。 "AppendRow"
"SummaryOnly"

BatchDeploymentProperties

名前 説明
{カスタマイズされたプロパティ} string

BatchRetrySettings

名前 説明
maxRetries ミニバッチの最大再試行回数 INT
timeout ISO 8601 形式のミニバッチの呼び出しタイムアウト。 string