New-AzTag

New-AzTag
    [-Name] <String>
    [[-Value] <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-AzTag
    [-ResourceId] <String>
    [-Tag] <Hashtable>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreatePredefinedTagSet: The New-AzTag 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-AzTag 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-AzTag cmdlet. To search for resource groups with a specified tag name or name and value, use the Tag parameter of the Get-AzResourceGroup 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.

CreateByResourceIdParameterSet: The New-AzTag cmdlet with a ResourceId creates or updates the entire set of tags on a resource or subscription. This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.

New-AzTag -Name "FY2015"

Name   ValuesTable Count Values
----   ----------- ----- ------
FY2015             0     {}

This 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-AzTag to add values to the tag. You can also specify a value when you apply the tag to the resource or resource group.

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values:

        Name        Count
        =========   =====
        Finance     0

This command creates a predefined tag named Department with a value of Finance.

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values:
        Name        Count
        =========   =====
        Finance     0
New-AzTag -Name "Department" -Value "IT"
Name:   Department
Count:  0
Values:
        Name        Count
        =========   =====
        Finance     0
        IT          0

These commands create a predefined tag named Department with two values. If the tag name exists, New-AzTag adds the value to the existing tag instead of creating a new one.

New-AzTag -Name "CostCenter" -Value "0001"

Name:   CostCenter
Count:  0
Values:
        Name        Count
        =========   =====
        0001        0

Set-AzResourceGroup -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

Get-AzTag -Name "CostCenter"

Name:   CostCenter
Count:  1
Values:
        Name        Count
        =========   =====
        0001        1

Get-AzResourceGroup -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   0001

The commands in this example create and use a predefined tag.

$Tags = @{"tagKey1"="tagValue1"; "tagKey2"="tagValue2"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $Tags

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             tagKey1  tagValue1
             tagKey2  tagValue2

This command creates or updates the entire set of tags on the subscription with {subId}.

$Tags = @{"Dept"="Finance"; "Status"="Normal"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -Tag $Tags

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             Dept     Finance
             Status   Normal

This command creates or updates the entire set of tags on the resource with {resourceId}.

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.