Stop-AzBatchPoolResize

Reference

Module:: Az.Batch

Stops a pool resize operation.

Syntax

Stop-AzBatchPoolResize
    [-Id] <String>
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Stop-AzBatchPoolResize cmdlet stops an Azure Batch resize operation on a pool.

Examples

Example 1: Stop resizing a pool

Stop-AzBatchPoolResize -Id "ContosoPool06" -BatchContext $Context

This command stops a resize operation on the pool that has the ID ContosoPool06. Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable.

Example 2: Stop resizing a pool by using the pipeline

Get-AzBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzBatchPoolResize -BatchContext $Context

This command stops resizing a pool by using the pipeline operator. The command gets the pool that has the ID ContosoPool06 by using the Get-AzBatchPool cmdlet. The command passes that pool object to the current cmdlet. The command stops the resize operation on that pool.

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

-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 pool for which this cmdlet stops a resizing operation.

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

Inputs

String

BatchAccountContext

Outputs

Void