通过

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

Remove-AzTag

  • 参考
模块:
Az.Resources

删除预定义的 Azure 标记或值 |删除资源或订阅上的整个标记集。

语法

Remove-AzTag
      [-Name] <String>
      [[-Value] <String[]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzTag
      [-PassThru]
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

RemovePredefinedTagSet： Remove-AzTag cmdlet 从订阅中删除预定义的 Azure 标记和值。 若要从预定义标记中删除特定值，请使用 Value 参数。 默认情况下， Remove-AzTag 将删除指定的标记及其所有值。不能删除当前应用于资源或资源组的标记或值。 在使用 Remove-AzTag 之前，请使用 Set-AzResourceGroup cmdlet 的 Tag 参数从资源或资源组中删除标记或值。 Remove-AzTag 的 Azure 标记模块可帮助管理预定义的 Azure 标记。 Azure 标记是一个名称值对，可用于按部门或成本中心对 Azure 资源和资源组进行分类，或者跟踪有关资源和组的笔记或注释。 可以在单个步骤中定义和应用标记，但预定义标记允许你为订阅中的标记建立标准、一致、可预测的名称和值。

RemoveByResourceIdParameterSet：带有 ResourceId 的 Remove-AzTag cmdlet 删除资源或订阅上的整个标记集。

示例

示例 1：删除预定义标记

Remove-AzTag -Name "Department"

此命令删除名为 Department 及其所有值的预定义标记。 如果标记已应用于任何资源或资源组，该命令将失败。

示例 2：从预定义标记中删除值

Remove-AzTag -Name "Department" -Value "HumanResources" -PassThru

Name:   Department
Count:  14
Values: 

        Name        Count
        =========   =====

        Finance        2
        IT            12

此命令从预定义的 Department 标记中删除 HumanResources 值。 它不会删除标记。 如果该值已应用于任何资源或资源组，则命令将失败。

示例 3：删除订阅上的整个标记集

Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

此命令使用 {subId} 删除订阅上的整个标记集。 如果未传入“-PassThru”，则不会返回已删除的对象。

示例 4：删除资源上的整个标记集

Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -PassThru

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

此命令使用 {resourceId} 删除资源上的整个标记集。 它在传入“-PassThru”时返回已删除的 oject。

参数

-Confirm

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

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

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

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Name

指定要删除的预定义标记的名称。 默认情况下， Remove-AzTag 将删除指定的标记及其所有值。 若要删除所选值，但不删除标记，请使用 Value 参数。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PassThru

返回一个对象，该对象表示已删除的标记或具有已删除值的生成的标记。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-ResourceId

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

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Value

从预定义标记中删除指定值，但不删除标记。

类型:String[]
Position:1
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-WhatIf

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

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

String

String[]

SwitchParameter

输出

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