New-AzureRmTag
Creates a predefined Azure tag or adds values to an existing tag.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
New-AzureRmTag
[-Name] <String>
[[-Value] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzureRmTag cmdlet creates a predefined Azure tag with an optional predefined value. You can also use it to add additional values to existing predefined tags. To create a predefined tag, enter a unique tag name. To add a value to an existing predefined tag, specify the name of the existing tag and the new value. This cmdlet returns an object that represents the new or modified tag with its values and the number of resources to which it has been applied. The Azure Tags module that New-AzureRmTag is part of can help you manage predefined Azure tags. An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. To apply a predefined tag to a resource or resource group, use the Tag parameter of the New-AzureRmTag cmdlet. To search for resource groups with a specified tag name or name and value, use the Tag parameter of the Get-AzureRMResourceGroup cmdlet. Every tag has a name. The values are optional. A predefined Azure tag can have multiple values, but when you apply the tag to a resource or resource group, you apply the tag name and only one of its values. For example, you can create a predefined Department tag with a value for each department, such as Finance, Human Resources, and IT. When you apply the Department tag to a resource, you apply only one predefined value, such as Finance.
Examples
Example 1: Create a predefined tag
PS C:\>New-AzureRmTag -Name "FY2015"
Name: FY2015
Count: 0
Values:
Name Count
========= =====
Finance 0This command creates a predefined tag named FY2015. This tag has no values. You can apply a tag with no values to a resource or resource group, or use New-AzureRmTag to add values to the tag. You can also specify a value when you apply the tag to the resource or resource group.
Example 2: Create a predefined tag with a value
PS C:\>New-AzureRmTag -Name "Department" -Value "Finance"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0This command creates a predefined tag named Department with a value of Finance.
Example 3: Add a value to a predefined tag
PS C:\>New-AzureRmTag -Name "Department" -Value "Finance"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0
PS C:\>New-AzureRmTag -Name "Department" -Value "IT"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0
IT 0These commands create a predefined tag named Department with two values. If the tag name exists, New-AzureRmTag adds the value to the existing tag instead of creating a new one.
Example 4: Use a predefined tag
PS C:\>New-AzureRmTag -Name "CostCenter" -Value "0001"
Name: CostCenter
Count: 0
Values:
Name Count
========= =====
0001 0
PS C:\>Set-AzureRmResourceGroup -Name "EngineerBlog" -Tag @{Name="CostCenter";Value="0001"}
Name: EngineerBlog
Location: East US
Resources:
Name Type Location
=============== ======================= ========
EngineerBlog Microsoft.Web/sites West US
EngSvr01 Microsoft.Sql/servers West US
EngDB02 Microsoft.Sql/databases West US
Tags:
Name Value
========== =====
CostCenter 0001
PS C:\>Get-AzureRmTag -Name "CostCenter"
Name: CostCenter
Count: 1
Values:
Name Count
========= =====
0001 1
PS C:\>Get-AzureRmResourceGroup -Tag @{Name="CostCenter"}
Name: EngineerBlog
Location: East US
Resources:
Name Type Location
=============== ======================= ========
EngineerBlog Microsoft.Web/sites West US
EngSvr01 Microsoft.Sql/servers West US
EngDB02 Microsoft.Sql/databases West US
Tags:
Name Value
========== =====
CostCenter 0001The commands in this example create and use a predefined tag.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the tag name. To create a new predefined tag, enter a unique name. To add a value to an existing tag, enter the name of the existing tag. If an existing predefined tag has the specified name, New-AzureRmTag adds the specified value, if any, to the tag with that name instead of creating a new tag.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Value
Specifies a tag value. Predefined tags can have multiple values, but you can enter only one value in each command. This parameter is optional, because tags can have names without values.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |