Set-AzureRmResourceGroup

Article
10/07/2015

Set-AzureRmResourceGroup

Changes the properties of a resource group

Syntax

Parameter Set: Default
Set-AzureRmResourceGroup [-Name] <String> [-Tag] <Hashtable[]> [ <CommonParameters>]

Detailed Description

This is the Description section

The Set-AzureRmResourceGroup cmdlet changes the properties of a resource group. You can use this cmdlet to add, change, or delete the Azure tags applied to a resource group. Use the Name parameter to identify the resource group and the Tag parameter to change the tags. You cannot use this cmdlet to change the name of a resource group.

Parameters

-Name<String>

Specifies the name of the resource group. This parameter identifies the resource group that you want to change.

Aliases	ResourceGroupName
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true(ByPropertyName)
Accept Wildcard Characters?	false

-Tag<Hashtable[]>

Replaces the tags for the resource group with the specified tags. To add or change a single tag, you must replace the collection of tags for the resource group.A "tag" is a name-value pair that you can create and apply to resources and resource groups. After you assign tags to resources and groups, you can use the Tag parameters of Get-AzureRmResource and Get-AzureRmResourceGroup to search for resources and groups by tag name or name and value. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources.Each tag must have a Name key. It can also have an optional Value key with one value. To specify a tag, use a hash table, such as @{Name="FY2015"} or @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as -Tag @{Name="FY2015"}, @{Name="Department";Value="IT"}.To delete a tag, enter a hash table with all tags currently applied to the resource group (from Get-AzureRmResourceGroup), except for the tag you want to delete. To delete all tags from a resource group, enter an empty hash table (-Tag @{}).

Aliases	Tags
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	true(ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None

Outputs

The output type is the type of the objects that the cmdlet emits.

Microsoft.Azure.Commands.Resources.Models.PSResourceGroup

Examples

-------------------------- Example 1: Apply a tag to a resource group --------------------------

This command applies a "Department" tag with a value of "IT" to a resource group that has no existing tags.

PS C:\>Set-AzureRmResourceGroup -Name ContosoRG -Tag @{Name="Department";Value="IT"}

-------------------------- Example 2: Add tags to a resource group --------------------------

This command adds a "Status" tag with a value of "Approved" and an "FY2016" tag to a resource group that has existing tags. Because the tags you specify replace the existing tags, you must include the existing tags in the new tag collection or you will lose them.The first command gets all existing tags of the ContosoRG resource group. It uses the Get-AzureRmResourceGroup cmdlet to get the ContosoRG resource group and then uses the dot method to get the value of its Tags property. It saves the existing tags in a $tags variable.The second command gets the tags in the $tags variable.The third command uses a "+=" operator to add the Status and FY2016 tags to the collection (array) of tags in the $tags variable.The fourth command uses the Tag parameter of Set-AzureRmResourceGroup to apply the tags in the $tags variable to the ContosoRG resource group.The fifth command shows the effect of the change. It gets all of the tags applied to the ContosoRG resource group. The output shows that the resource group has the Department tag and the two new tags, Status and FY2015.

PS C:\>$tags = (Get-AzureRmResourceGroup -Name ContosoRG).Tags

PS C:\>$tags


Tags: 

      Name        Value
      ====        ======
      Department  IT


PS C:\>$tags += @{Name="Status";Value="Approved"}, @{Name="FY2016"}

PS C:\>Set-AzureRmResourceGroup -Name ContosoRG -Tag $tags

PS C:>(Get-AzureRmResourceGroup -Name ContosoRG).Tags


Tags: 

      Name        Value
      ====        ======
      Department  IT
      Status      Approved
      FY2016

-------------------------- Example 3: Delete all tags --------------------------

This command deletes all tags from the ContosoRG resource group. It uses the Tag parameter with an empty hash table value.

PS C:\>Set-AzureRmResourceGroup -Name ContosoRG -Tag @{}

Set-AzureRmResourceGroup