Edit

Enable-AzBatchComputeNodeScheduling

  • Reference
Module:
Az.Batch

Enables task scheduling on the specified compute node.

Syntax

Enable-AzBatchComputeNodeScheduling
      [-PoolId] <String>
      [-Id] <String>
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Enable-AzBatchComputeNodeScheduling
      [[-ComputeNode] <PSComputeNode>]
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Enable-AzBatchComputeNodeScheduling cmdlet enables task scheduling on the specified compute node. A compute node is an Azure virtual machine dedicated to a specific application workload.

Examples

Example 1: Enable task scheduling on a compute node

$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount"
Enable-AzBatchComputeNodeScheduling  -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context

These commands enable task scheduling on the compute node tvm-1783593343_34-20151117t222514z. To do this, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context. The second command then uses this object reference and the Enable-AzBatchComputeNodeScheduling cmdlet to connect to the pool myPool and enable task scheduling on tvm-1783593343_34-20151117t222514z.

Example 2: Enable task scheduling on compute nodes in a pool

$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount"
Get-AzBatchComputeNode -PoolId "Pool06"  -BatchContext $Context | Enable-AzBatchComputeNodeScheduling  -BatchContext $Context

These commands enable task scheduling on all the compute nodes found in the pool Pool06. To perform this task, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context. The second command in the example then uses this object reference and Get-AzBatchComputeNode to return a collection of all the compute nodes found in Pool06. That collection is then piped to the Enable-AzBatchComputeNodeScheduling cmdlet, which enables task scheduling on each compute node in the collection.

Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property.

Type:BatchAccountContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputeNode

Specifies an object reference to the compute node where task scheduling is enabled. This object reference is created by using the Get-AzBatchComputeNode cmdlet and storing the returned compute node object in a variable.

Type:PSComputeNode
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the ID of the compute node where task scheduling is enabled.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PoolId

Specifies the ID of the batch pool that contains the compute node where task scheduling is enabled.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSComputeNode

BatchAccountContext

Outputs

Void