你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzTag

创建预定义的 Azure 标记或向现有标记添加值 |在资源或订阅上创建或更新整个标记集。

语法

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

说明

CreatePredefinedTagSetNew-AzTag cmdlet 创建具有可选预定义值的预定义 Azure 标记。 还可以使用它向现有预定义标记添加其他值。 若要创建预定义标记,请输入唯一的标记名称。 若要向现有预定义标记添加值,请指定现有标记的名称和新值。 此 cmdlet 返回一个对象,该对象代表新的或修改的标记及其值及其应用的资源数。 New-AzTag 所属的 Azure 标记模块可帮助管理预定义的 Azure 标记。 Azure 标记是一个名称值对,可用于按部门或成本中心对 Azure 资源和资源组进行分类,或者跟踪有关资源和组的笔记或注释。 可以在单个步骤中定义和应用标记,但预定义标记允许你为订阅中的标记建立标准、一致、可预测的名称和值。 若要将预定义标记应用于资源或资源组,请使用 New-AzTag cmdlet 的 Tag 参数。 若要搜索具有指定标记名称或名称和值的资源组,请使用 Get-AzResourceGroup cmdlet 的 Tag 参数。 每个标记都有一个名称。 这些值是可选的。 预定义的 Azure 标记可以有多个值,但在将标记应用于资源或资源组时,只需应用标记名称和其中一个值。 例如,可以为每个部门(例如财务、人力资源和 IT)创建一个具有值的预定义部门标记。 将 Department 标记应用于资源时,仅应用一个预定义值,例如 Finance。

CreateByResourceIdParameterSet使用 ResourceId 的 New-AzTag cmdlet 在资源或订阅上创建或更新整个标记集。 此操作允许在指定的资源或订阅上添加或替换整个标记集。 指定的实体最多可以有 50 个标记。

示例

示例 1:创建预定义标记

New-AzTag -Name "FY2015"

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

此命令创建名为 FY2015 的预定义标记。 此标记没有值。 可以将不带值的标记应用于资源或资源组,也可以使用 New-AzTag 向标记添加值。 还可以在将标记应用于资源或资源组时指定值。

示例 2:创建具有值的预定义标记

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

Name:   Department
Count:  0
Values: 

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

此命令创建一个名为 Department 的预定义标记,其值为 Finance。

示例 3:向预定义标记添加值

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

这些命令创建一个名为 Department 的预定义标记,其中包含两个值。 如果标记名称存在, New-AzTag 会将值添加到现有标记,而不是创建新的标记。

示例 4:使用预定义标记

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

此示例中的命令创建并使用预定义标记。

示例 5:在订阅上创建或更新整个标记集

$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

此命令使用 {subId} 在订阅上创建或更新整个标记集。

示例 6:在资源上创建或更新整个标记集

$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

此命令使用 {resourceId} 在资源上创建或更新整个标记集。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

指定预定义的标记名称。 若要创建新的预定义标记,请输入唯一的名称。 若要向现有标记添加值,请输入现有标记的名称。 如果现有预定义标记具有指定的名称, 则 New-AzTag 会将指定值(如果有)添加到具有该名称的标记,而不是创建新标记。

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

-ResourceId

要标记的实体的资源标识符。 可以标记资源、资源组或订阅。

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

-Tag

要放入资源的标记。

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

-Value

指定预定义标记值。 预定义标记可以有多个值,但在每个命令中只能输入一个值。 此参数是可选的,因为标记可以具有没有值的名称。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

String

Hashtable

输出

Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource