how do I change name of a tag

Question

how do I change name of a tag

Fredrik Johansson 21

I need help in how to change name on a tag applied to many resources. Just need to change the actual name of the tag and so it is updated on all resources and no other tags are deleted. The value will be the same so just look to in a quick way change the tagname. We named a tag region but need to change it to country for example.

Thank you in advance

SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-27T05:01:50.4233333+00:00

Fredrik Johansson Hope you had chance to go through my previous comments. If the provided answer is helpful, please accept as answer it would be beneficial to customers who are facing similar issues. If you need further assistance, kindly provide further context to assist you accordingly.

1 answer

Your answer

SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-27T05:01:50.4233333+00:00

Fredrik Johansson Hope you had chance to go through my previous comments. If the provided answer is helpful, please accept as answer it would be beneficial to customers who are facing similar issues. If you need further assistance, kindly provide further context to assist you accordingly.

Answer 1

SwathiDhanwada-MSFT 18,996 Moderator

Fredrik Johansson Welcome to Microsoft Q & A Community Forum. You can selectively update the set of tags on a subscription or resource with "Replace" Operation. Below is sample command for your reference.

$replacedTags = @{"key1"="value1"; "key3"="value3";}
Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $replacedTags -Operation Replace

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             key1     value1
             key3     value3

For more information, refer this document : https://learn.microsoft.com/en-us/powershell/module/az.resources/update-aztag?view=azps-10.3.0

Fredrik Johansson 21 Reputation points

2023-09-26T11:37:21.78+00:00

Hi, this was not exact what was asked. I do not want to replace like that. I just want to change the name on a specific tag that is used on a lot of resources without changing value. The same also not to touch any other existing tags on the resources. Just a simple switch in the name of the tag region. Just remove the word region in name and have country instead and leave all values as are and all other tags intact on the resources.
Fredrik Johansson 21 Reputation points

2023-09-26T11:39:39.3633333+00:00

Hi, this was not exact what was asked. I do not want to replace like that. I just want to change the name on a specific tag that is used on a lot of resources without changing value. The same also not to touch any other existing tags on the resources. Just a simple switch in the name of the tag region. Just remove the word region in name and have country instead and leave all values as are and all other tags intact on the resources. best regards Fredrik
Fredrik Johansson 21 Reputation points

2023-09-26T11:40:54.59+00:00

Hi, this was not exact what was asked. I do not want to replace like that. I just want to change the name on a specific tag that is used on a lot of resources without changing value. The same also not to touch any other existing tags on the resources. Just a simple switch in the name of the tag region. Just remove the word region in name and have country instead and leave all values as are and all other tags intact on the resource

SwathiDhanwada-MSFT 18,996 Moderator

Fredrik Johansson Kindly note the tag key value can't be updated partially. You can use below sample code to update the tag key. I have tested it for single resource. Based on your requirements, you can modify it accordingly. This code updates the tag key while using the previous tag value of the resource.


Connect-AzAccount -Tenant "" -Subscription ""

$tagName = "Reason"
$newTagName = "Lab"

# Get the resource and its tags
$resource = Get-AzResource -ResourceId ""

# Check if the old tag name exists
if ($resource.Tags.ContainsKey($tagName)) {
    # Remove the old tag name and add the new tag name
    $tagValue = $resource.Tags[$tagName]
    $resource.Tags.Remove($tagName)
    $resource.Tags.Add($newTagName, $tagValue)
    # Update the resource with the new tags
    $resource | Set-AzResource -Force
}

Fredrik Johansson 21 Reputation points

2023-09-27T08:10:12.3766667+00:00

I don´t exactly understand the response. What do you mean by tagkey? That tagname right? I still see in the code the resource name so do I steel need to do this 1 by 1 resource by resource under all my 41 subscriptions? That will be hours of work. There is no easier way and to be honest then not saving time than having to do the same task in the portal? really struggling to understand why there cannot be a quicker and simpler way to do this specific task. In excel this would take 30 seconds. Best regards Fredrik

SwathiDhanwada-MSFT 18,996 Moderator

Fredrik Johansson I understand your concern and frustration regarding the time-consuming nature of updating tags on resources, especially across multiple subscriptions.

Using PowerShell scripts, we can automate the task of updating tags for resources, eliminating the need for manual, resource-by-resource updates. I have provided you a sample solution on how it can be done for a resource. If the case is for multiple subscriptions and multiple resources, the solution needs to be modified based on the requirement.

On your confusion about tag name or Tag Key: - Tags, also referred to as key-value pairs or name-value pairs. These cannot be modified in a partial manner.

Here is draft version of code you requested. Update it with appropriate values and test it out on a subscription to check if it fits your requirement.


Import-Module -Name Az.Resources
# Get all subscriptions in the Azure account

try {
    "Logging in to Azure..."
    Connect-AzAccount
}
catch {
    Write-Error -Message $_.Exception
    throw $_.Exception
}
$subscriptions = Get-AzSubscription  

# Loop through each subscription
foreach ($subscription in $subscriptions) {
    # Set the current subscription
    Set-AzContext -SubscriptionId $subscription.SubscriptionId 

    # Get all resource groups for the subscription
    $resourceGroups = Get-AzResourceGroup 
    
    $tagName = "Region"
    $newTagName = "Country"
    # Loop through each resource provider
    foreach ($rg in $resourceGroups) {
        $resources = Get-AzResource -ResourceGroupName $rg.ResourceGroupName
        foreach ($r in $resources) {
            $resourceId = Get-AzResource -ResourceId $r.ResourceId
            if ($resourceId.Tags.ContainsKey("Region")) {
                $tagValue = $resourceId.Tags[$tagName]
                $resourceId.Tags.Remove($tagName)
                $resourceId.Tags.Add($newTagName, $tagValue)
                # Update the resource with the new tags
                $resourceId | Set-AzResource -Force
            }
        }
    }
}

Fredrik Johansson 21 Reputation points

2023-09-27T10:51:01.26+00:00

The case is for multiple subscriptions and multiple resources so what would the modified solution look like? As otherwise need to do the script for each resource and that would be many scripts that would need to be run. Best regards Fredrik
SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-27T13:42:03.22+00:00

The above script provided works for multiple subscriptions and multiple resources.
Fredrik Johansson 21 Reputation points

2023-09-27T14:02:29.62+00:00

not sure I understand completely. As I login to powershell and connect subscription by subscription? And If I enter subscription id and resource id in that script above it is only that id and resource that updates and not all. Was there supposed to be 1 more script?
Fredrik Johansson 21 Reputation points

2023-09-28T11:36:56.1666667+00:00

not sure I understand completely. As I login to powershell and connect subscription by subscription? And If I enter subscription id and resource id in that script above it is only that id and resource that updates and not all. Was there supposed to be 1 more script?

any update on above? A call possible? how do I wee which elements should be populated by me?
SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-28T11:59:02.59+00:00

Fredrik Johansson When logged on, the script automatically retrieves all the subscriptions in your account and then recursively retrieves resource groups and then resources and updates the tag on them based on the permissions you have on the subscriptions.

Also, kindly note that community forums aim to empower users by providing guidance, fostering learning, and promoting self-discovery rather than offering ready-made solutions. We encourage users to understand concepts, learn through shared experiences, and adapt solutions to your unique requirements.

I encourage you to try testing the script provided as part of my previous comments. Should you encounter any challenges or have questions during the process, please don't hesitate to reach out.
SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-29T05:47:44.44+00:00

Fredrik Johansson Have you tested the script provided ? Were you facing any errors ?

Fredrik Johansson 21

I run it but got below error. Also it just connects me to 1 of the 58 subscriptions so I get error there as well first but due to GDPR I cannot share that error here online as includes details.

You cannot call a method on a null-valued expression.
At line:29 char:17
+             if ($resourceId.Tags.ContainsKey("Region")) {
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Fredrik Johansson 21

I got first error I could only connect to 1 of 58 subscriptions, due to Gdpr I cannot share that error here online. Then got below error.

You cannot call a method on a null-valued expression.
At line:29 char:17
+             if ($resourceId.Tags.ContainsKey("Region")) {
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

SwathiDhanwada-MSFT 18,996 Reputation points Moderator

2023-09-29T12:46:23.7633333+00:00

Fredrik Johansson I wish to engage with you offline for a closer look and provide a quick and specialized assistance, please send an email with subject line “Attn:Swathi” to AzCommunity[at]Microsoft[dot]com referencing this thread and the Azure subscription ID, I will follow-up with you.

SwathiDhanwada-MSFT 18,996 Moderator

Fredrik Johansson With Tag Contributor permissions, you will not be able to update tags from above provided code. You can below sample solution to update tags with just tag contributor permissions.

Connect-AzAccount -Tenant "" -Subscription ""

Select-AzSubscription -SubscriptionName ""

$tagName = "Region"

# Get the resource and its tags
$resource = Get-AzResource -ResourceId ""

# Check if the old tag name exists
if ($resource.Tags.ContainsKey($tagName)) {
    # Remove the old tag name and add the new tag name
    $tagValue = $resource.Tags[$tagName]
    $deletedTags = @{"Region"=$tagValue}
    Update-AzTag -ResourceId $resource.Id -Tag $deletedTags -Operation Delete
    $mergedTags = @{"Country"=$tagValue}
    Update-AzTag -ResourceId $resource.Id -Tag $mergedTags -Operation Merge

}

Share via

how do I change name of a tag

1 answer

Your answer