Update-AzCapacityReservationGroup

Reference

Module:: Az.Compute

Update the Capacity Reservation Group.

Syntax

Update-AzCapacityReservationGroup
      [-SharingProfile <String[]>]
      [-AsJob]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCapacityReservationGroup
      -ResourceGroupName <String>
      -Name <String>
      [-SharingProfile <String[]>]
      [-AsJob]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCapacityReservationGroup
      -CapacityReservationGroup <PSCapacityReservationGroup>
      [-SharingProfile <String[]>]
      [-AsJob]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCapacityReservationGroup
      -ResourceId <String>
      [-SharingProfile <String[]>]
      [-AsJob]
      [-Tag <Hashtable>]
      [-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

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

-CapacityReservationGroup

PSCapacityReservationGroup object to update.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

-Name

Name of the Capacity Reservation Group.

Type:	String
Aliases:	CapacityReservationGroupName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of a resource group.

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

-ResourceId

Resource ID for your Capacity Reservation Group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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}"

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags.

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSCapacityReservationGroup

Hashtable

Outputs