Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Update-AzCapacityReservation

Update the Capacity Reservation.

Syntax

DefaultParameter (Default) 

Update-AzCapacityReservation
 [-CapacityToReserve <Int32>]
 [-AsJob]
 [-Tag <Hashtable>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

DefaultParameterSet 

Update-AzCapacityReservation
 -ResourceGroupName <String>
 -ReservationGroupName <String>
 -Name <String>
 [-CapacityToReserve <Int32>]
 [-AsJob]
 [-Tag <Hashtable>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

InputObjectParameterSet 

Update-AzCapacityReservation
 -CapacityReservation <PSCapacityReservation>
 [-CapacityToReserve <Int32>]
 [-AsJob]
 [-Tag <Hashtable>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

ResourceIDParameterSet 

Update-AzCapacityReservation
 -ResourceId <String>
 [-CapacityToReserve <Int32>]
 [-AsJob]
 [-Tag <Hashtable>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Update the Capacity Reservation.

Examples

Example 1

Update-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName $capResGroup -Name $capRes -CapacityToReserve 4

Updating the capacity reservation.

Example 2

Get-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName $capResGroup -Name $capRes | Update-AzCapacityReservation -CapacityToReserve 4

Updating the capacity reservation using the InputObject parameter set.

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-CapacityReservation

PSCapacityReservation object to update.

Parameter properties

Type:PSCapacityReservation
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-CapacityToReserve

Specifies the number of virtual machines in the scale set.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

Name of the Capacity Reservation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CapacityReservationName

Parameter sets

-ReservationGroupName

Name of the Capacity Reservation Group that the capacity reservation resource is in.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:CapacityReservationGroupName

Parameter sets

-ResourceGroupName

Specifies the name of a resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceId

Resource ID for your Capacity Reservation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Tag

Resource tags.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSCapacityReservation

Int32

Hashtable

Outputs

PSCapacityReservation

Feedback

Was this page helpful?