次の方法で共有


Pool - Update Properties

指定した Pool のプロパティを更新します。
これにより、Pool のすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前 / 必須 説明
batchUrl
path True

string

すべてのAzure Batchサービス要求のベース URL。

poolId
path True

string

更新するプールの ID。

api-version
query True

string

クライアント API のバージョン。

timeout
query

integer

int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

名前 必須 説明
client-request-id

string

uuid

呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 など)。

return-client-request-id

boolean

サーバーが応答で client-request-id を返す必要があるかどうか。

ocp-date

string

date-time-rfc1123

要求が発行された時刻。 クライアント ライブラリは通常、これを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

Media Types: "application/json; odata=minimalmetadata"

名前 必須 説明
applicationPackageReferences True

ApplicationPackageReference[]

プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。
この一覧は、プール上の既存のアプリケーション パッケージ参照を置き換えます。 アプリケーション パッケージ参照への変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 任意のプールには、最大 10 個のアプリケーション パッケージ参照があります。 省略した場合、または空のコレクションを指定した場合、既存のアプリケーション パッケージ参照はすべてプールから削除されます。 特定のプールでは、最大 10 個の参照を指定できます。

certificateReferences True

CertificateReference[]

プール内の各コンピューティング ノードにインストールする証明書の一覧。
この一覧は、プールで構成されている既存の証明書参照を置き換えます。 空のコレクションを指定すると、既存の証明書参照はすべてプールから削除されます。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。

警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。

metadata True

MetadataItem[]

プールにメタデータとして関連付けられている名前と値のペアの一覧。
この一覧は、プールで構成されている既存のメタデータを置き換えます。 省略した場合、または空のコレクションを指定した場合、既存のメタデータはすべて Pool から削除されます。

startTask

StartTask

プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
この要素が存在する場合は、既存の StartTask が上書きされます。 省略すると、既存の StartTask がプールから削除されます。

targetNodeCommunicationMode

NodeCommunicationMode

プールの目的のノード通信モード。
この設定は、プールの既存の targetNodeCommunication 設定を置き換えます。 省略した場合、既存の設定は既定です。

応答

名前 説明
204 No Content

Batch サービスへの要求が成功しました。

ヘッダー

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Authorization

型: apiKey
/: header

Pool update

要求のサンプル

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

応答のサンプル

定義

名前 説明
ApplicationPackageReference

コンピューティング ノードにデプロイするパッケージへの参照。

AutoUserScope

自動ユーザーのスコープ

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

BatchError

Azure Batch サービスから受信したエラー応答。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

CertificateReference

プール内のコンピューティング ノードにインストールされる証明書への参照。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

CertificateVisibility

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

ContainerRegistry

プライベート コンテナー レジストリ。

ContainerWorkingDirectory

コンテナー Task 作業ディレクトリの場所。

ElevationLevel

ユーザーの昇格レベル。

EnvironmentSetting

タスク プロセスで設定する環境変数。

ErrorMessage

Azure Batch エラー応答で受信したエラー メッセージ。

MetadataItem

Batch サービス リソースに関連付けられている名前と値のペア。

NodeCommunicationMode

プールが Batch サービスと通信する方法を決定します。

PoolUpdatePropertiesParameter

プールに対して行われる一連の変更。

ResourceFile

コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。

StartTask

ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

TaskContainerSettings

タスクのコンテナー設定。

UserIdentity

タスクを実行するユーザー ID の定義。

ApplicationPackageReference

コンピューティング ノードにデプロイするパッケージへの参照。

名前 説明
applicationId

string

デプロイするアプリケーションの ID。
プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。

version

string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。
プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 Task でこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AutoUserScope

自動ユーザーのスコープ

名前 説明
pool

string

タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されることを指定します。

task

string

サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

名前 説明
elevationLevel

ElevationLevel

自動ユーザーの昇格レベル。
既定値は nonAdmin です。

scope

AutoUserScope

自動ユーザーのスコープ
既定値は pool です。 プールで Windows が実行されている場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが StartTasks からアクセスできる証明書がプールで指定されている場合などです。

BatchError

Azure Batch サービスから受信したエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

message

ErrorMessage

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

values

BatchErrorDetail[]

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前 説明
key

string

Value プロパティの意味を指定する識別子。

value

string

エラー応答に含まれる追加情報。

CertificateReference

プール内のコンピューティング ノードにインストールされる証明書への参照。

名前 説明
storeLocation

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
既定値は currentuser です。 このプロパティは、Windows コンピューティング ノード (cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用して virtualMachineConfiguration を使用して作成されたプール) にのみ適用されます。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。

storeName

string

証明書をインストールするコンピューティング ノード上の証明書ストアの名前。
このプロパティは、Windows コンピューティング ノード (cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用して virtualMachineConfiguration を使用して作成されたプール) にのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、任意のカスタム ストア名も使用できます。 既定値は、My です。

thumbprint

string

証明書の拇印。

thumbprintAlgorithm

string

拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。

visibility

CertificateVisibility[]

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
このコレクションでは、複数の可視性を指定できます。 既定値はすべてのアカウントです。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

名前 説明
currentuser

string

証明書は CurrentUser 証明書ストアにインストールする必要があります。

localmachine

string

証明書は LocalMachine 証明書ストアにインストールする必要があります。

CertificateVisibility

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。

名前 説明
remoteuser

string

証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示されます。

starttask

string

証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。

task

string

[証明書] は、ジョブ タスクが実行されているユーザー アカウントに表示されます。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

名前 説明
resourceId

string

ユーザー割り当て ID の ARM リソース ID。

ContainerRegistry

プライベート コンテナー レジストリ。

名前 説明
identityReference

ComputeNodeIdentityReference

ユーザー名とパスワードではなく、Azure Container Registryへのアクセスに使用するユーザー割り当て ID への参照。
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

password

string

レジストリ サーバーにログインするためのパスワード。

registryServer

string

レジストリ URL。
省略すると、既定値は "docker.io" になります。

username

string

レジストリ サーバーにログインするユーザー名。

ContainerWorkingDirectory

コンテナー Task 作業ディレクトリの場所。

名前 説明
containerImageDefault

string

コンテナー Image で定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。

taskWorkingDirectory

string

標準の Batch サービス Task 作業ディレクトリを使用します。このディレクトリには、Batch によって設定されたタスク リソース ファイルが含まれます。

ElevationLevel

ユーザーの昇格レベル。

名前 説明
admin

string

ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。

nonadmin

string

ユーザーは、昇格されたアクセス権のない標準ユーザーです。

EnvironmentSetting

タスク プロセスで設定する環境変数。

名前 説明
name

string

環境変数の名前。

value

string

環境変数の値。

ErrorMessage

Azure Batch エラー応答で受信したエラー メッセージ。

名前 説明
lang

string

エラー メッセージの言語コード

value

string

メッセージのテキストです。

MetadataItem

Batch サービス リソースに関連付けられている名前と値のペア。

名前 説明
name

string

メタデータ 項目の名前。

value

string

メタデータ項目の値。

NodeCommunicationMode

プールが Batch サービスと通信する方法を決定します。

名前 説明
classic

string

クラシック通信モードを使用するノードでは、"BatchNodeManagement" からのポート 29876 と 29877 での受信 TCP 通信が必要です。{region}" サービス タグとポート 443 の "Storage.region" と "BatchNodeManagement への送信 TCP 通信。{region}" サービス タグ。

default

string

ノード通信モードは、Batch サービスによって自動的に設定されます。

simplified

string

簡略化された通信モードを使用するノードでは、ポート 443 で "BatchNodeManagement" への送信 TCP 通信が必要です。{region}" サービス タグ。 開いている受信ポートは必要ありません。

PoolUpdatePropertiesParameter

プールに対して行われる一連の変更。

名前 説明
applicationPackageReferences

ApplicationPackageReference[]

プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。
この一覧は、プール上の既存のアプリケーション パッケージ参照を置き換えます。 アプリケーション パッケージ参照への変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 任意のプールには、最大 10 個のアプリケーション パッケージ参照があります。 省略した場合、または空のコレクションを指定した場合、既存のアプリケーション パッケージ参照はすべてプールから削除されます。 特定のプールでは、最大 10 個の参照を指定できます。

certificateReferences

CertificateReference[]

プール内の各コンピューティング ノードにインストールする証明書の一覧。
この一覧は、プールで構成されている既存の証明書参照を置き換えます。 空のコレクションを指定すると、既存の証明書参照はすべてプールから削除されます。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。

警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。

metadata

MetadataItem[]

プールにメタデータとして関連付けられている名前と値のペアの一覧。
この一覧は、プールで構成されている既存のメタデータを置き換えます。 省略した場合、または空のコレクションを指定した場合、既存のメタデータはすべてプールから削除されます。

startTask

StartTask

プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
この要素が存在する場合は、既存の StartTask が上書きされます。 省略すると、既存の StartTask がプールから削除されます。

targetNodeCommunicationMode

NodeCommunicationMode

プールの目的のノード通信モード。
この設定は、プールの既存の targetNodeCommunication 設定を置き換えます。 省略した場合、既存の設定は既定です。

ResourceFile

コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。

名前 説明
autoStorageContainerName

string

自動ストレージ アカウント内のストレージ コンテナー名。
autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。

blobPrefix

string

Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。
このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスを指定しない場合、コンテナー内のすべてのファイルがダウンロードされます。

fileMode

string

ファイルアクセス許可モード属性 (8 進数形式)。
このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 これは、Windows コンピューティング ノードにダウンロードされる resourceFile に指定されている場合は無視されます。 Linux コンピューティング ノードにこのプロパティが指定されていない場合、既定値の 0770 がファイルに適用されます。

filePath

string

タスクの作業ディレクトリを基準にして、ファイルをダウンロードするコンピューティング ノード上の場所。
httpUrl プロパティを指定した場合、filePath は必須であり、ファイル名を含むファイルのダウンロード先のパスを記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath をディレクトリとして使用する場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。

httpUrl

string

ダウンロードするファイルの URL。
autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storageを指している場合は、コンピューティング ノードから読み取り可能である必要があります。 Azure Storage で BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。

identityReference

ComputeNodeIdentityReference

storageContainerUrl または httpUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

storageContainerUrl

string

Azure Blob Storage内の BLOB コンテナーの URL。
autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りとリストのアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りと一覧表示のアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。

StartTask

ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

名前 説明
commandLine

string

StartTask のコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (タスク作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

containerSettings

TaskContainerSettings

StartTask を実行するコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batchディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、Task コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIRの外部のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

environmentSettings

EnvironmentSetting[]

StartTask の環境変数設定の一覧。

maxTaskRetryCount

integer

タスクを再試行できる最大回数。
終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (最初の再試行が 1 回、再試行回数が 3 回)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクやタスクには推奨されません。 既定値は 0 (再試行なし) です。

resourceFiles

ResourceFile[]

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。

userIdentity

UserIdentity

StartTask を実行するユーザー ID。
省略すると、Task は Task に固有の非管理ユーザーとして実行されます。

waitForSuccess

boolean

コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで待機する必要があるかどうか (つまり、終了コード 0 で終了する)。
True で Node で StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、他のタスクがコンピューティング ノードで実行を開始できます。StartTask が失敗した場合でも、新しいタスクは引き続きコンピューティング ノードでスケジュールされます。 既定値は true です。

TaskContainerSettings

タスクのコンテナー設定。

名前 説明
containerRunOptions

string

コンテナー作成コマンドの追加オプション。
これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。

imageName

string

タスクを実行するコンテナーの作成に使用するイメージ。
これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合、タグ ":latest" が既定として使用されます。

registry

ContainerRegistry

コンテナー イメージを含むプライベート レジストリ。
この設定は、プールの作成時に既に指定されている場合は省略できます。

workingDirectory

ContainerWorkingDirectory

コンテナー Task 作業ディレクトリの場所。
既定値は 'taskWorkingDirectory' です。

UserIdentity

タスクを実行するユーザー ID の定義。

名前 説明
autoUser

AutoUserSpecification

タスクを実行する自動ユーザー。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

username

string

タスクを実行するユーザー ID の名前。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。