ComputeBatchModelFactory.BatchPoolReplaceOptions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Parameters for replacing properties on an Azure Batch Pool.
public static Azure.Compute.Batch.BatchPoolReplaceOptions BatchPoolReplaceOptions(Azure.Compute.Batch.BatchStartTask startTask = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchApplicationPackageReference> applicationPackageReferences = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchMetadataItem> metadata = default);static member BatchPoolReplaceOptions : Azure.Compute.Batch.BatchStartTask * seq<Azure.Compute.Batch.BatchApplicationPackageReference> * seq<Azure.Compute.Batch.BatchMetadataItem> -> Azure.Compute.Batch.BatchPoolReplaceOptionsPublic Shared Function BatchPoolReplaceOptions (Optional startTask As BatchStartTask = Nothing, Optional applicationPackageReferences As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional metadata As IEnumerable(Of BatchMetadataItem) = Nothing) As BatchPoolReplaceOptionsParameters
- startTask
- BatchStartTask
A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool.
- applicationPackageReferences
- IEnumerable<BatchApplicationPackageReference>
The list of Application Packages to be installed on each Compute Node in the Pool. The list replaces any existing Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.
- metadata
- IEnumerable<BatchMetadataItem>
A list of name-value pairs associated with the Pool as metadata. This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool.
Returns
A new BatchPoolReplaceOptions instance for mocking.
