Update-AzCapacityReservationGroup
Update the Capacity Reservation Group.
Syntax
DefaultParameter (Default)
Update-AzCapacityReservationGroup
[-SharingProfile <String[]>]
[-AsJob]
[-Tag <Hashtable>]
[-ReservationType <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DefaultParameterSet
Update-AzCapacityReservationGroup
-ResourceGroupName <String>
-Name <String>
[-SharingProfile <String[]>]
[-AsJob]
[-Tag <Hashtable>]
[-ReservationType <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzCapacityReservationGroup
-CapacityReservationGroup <PSCapacityReservationGroup>
[-SharingProfile <String[]>]
[-AsJob]
[-Tag <Hashtable>]
[-ReservationType <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIDParameterSet
Update-AzCapacityReservationGroup
-ResourceId <String>
[-SharingProfile <String[]>]
[-AsJob]
[-Tag <Hashtable>]
[-ReservationType <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the Capacity Reservation Group.
Examples
Example 1
Update-AzCapacityReservationGroup -ResourceGroupName $rgname -Name $capResGroup -Tag @{ CreatedBy = "John" }
Updating the Capacity Reservation Group's tags.
Example 2
Get-AzCapacityReservationGroup -ResourceGroupName $rgname -Name $capResGroup | Update-AzCapacityReservationGroup -Tag @{ CreatedBy = "John" }
Updating the Capacity Reservation Group's tags 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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CapacityReservationGroup
PSCapacityReservationGroup object to update.
Parameter properties
Parameter sets
InputObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the Capacity Reservation Group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: CapacityReservationGroupName
Parameter sets
DefaultParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ReservationType
Specifies the type of the capacity reservation group.
'Targeted' reservations are consumed by virtual machines that are explicitly associated with the group.
'Block' reservations are consumed only from the capacity block.
'Open' reservations are implicitly consumed by eligible virtual machines with a matching VM size and zone without associating the group.
The reservation type cannot be changed after the group is created.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Specifies the name of a resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
Resource ID for your Capacity Reservation Group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceIDParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SharingProfile
Allows a Capacity Reservation Group to be shared across subscriptions. Pass "" to unshare all subscriptions. It is an array of strings; Contains an array of Arm resource ids of subscriptions
eg : "/subscriptions/{subscriptionId1}", "/subscriptions/{subscriptionId2}"
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
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 .
Outputs
