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

Set-AzureRmResourceGroup

修改资源组。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Set-AzureRmResourceGroup
   [-Name] <String>
   [-Tag] <Hashtable>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzureRmResourceGroup
   [-Tag] <Hashtable>
   [-Id] <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Set-AzureRmResourceGroup cmdlet 修改资源组的属性。 可以使用此 cmdlet 添加、更改或删除应用于资源组的 Azure 标记。 指定 Name 参数以标识资源组和 标记 参数以修改标记。 不能使用此 cmdlet 更改资源组的名称。

示例

示例 1:将标记应用于资源组

PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{Department="IT"}

此命令将具有 IT 值的 Department 标记应用于没有现有标记的资源组。

示例 2:向资源组添加标记

PS C:\>$Tags = (Get-AzureRmResourceGroup -Name "ContosoRG").Tags
PS C:\> $Tags
PS C:\> $Tags += @{"Status"="Approved"; "FY2016"=$null}
PS C:\> Set-AzureRmResourceGroup -Name "ContosoRG" -Tag $Tags
PS C:> (Get-AzureRmResourceGroup -Name "ContosoRG").Tags

本示例向具有现有标记的资源组添加值为“已批准”和“FY2016”标记的状态标记。 由于指定的标记替换了现有标记,因此必须在新的标记集合中包含现有标记,否则将丢失这些标记。 第一个命令获取 ContosoRG 资源组,并使用 dot 方法获取其 Tags 属性的值。 该命令将标记存储在$Tags变量中。 第二个命令获取$Tags变量中的标记。 第三个命令使用 += 赋值运算符将 Status 和 FY2016 标记添加到$Tags变量中的标记数组。 第四个命令使用 Set-AzureRmResourceGroupTag 参数将$Tags变量中的标记应用于 ContosoRG 资源组。 第五个命令获取应用于 ContosoRG 资源组的所有标记。 输出显示资源组具有 Department 标记和两个新标记“状态”和“FY2015”。

示例 3:删除资源组的所有标记

PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{}

此命令指定 具有空哈希表值的 Tag 参数,以从 ContosoRG 资源组中删除所有标记。

参数

-ApiVersion

指定资源提供程序支持的 API 版本。 可以指定与默认版本不同的版本。

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

-DefaultProfile

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

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

-Id

指定要修改的资源组的 ID。

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

-Name

指定要修改的资源组的名称。

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

-Pre

指示此 cmdlet 在自动确定要使用的版本时会考虑预发布 API 版本。

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

-Tag

以哈希表的形式进行键值对。 例如:@{key0=“value0”;key1=$null;key2=“value2”} 标记是一个名称/值对,可以创建并应用于资源和资源组。 将标记分配给资源和组后,可以使用 Get-AzureRmResource 和 Get-AzureRmResourceGroup 的 Tag 参数按标记名称或名称和值搜索资源和组。 可以使用标记按部门或成本中心对资源进行分类,或者跟踪有关资源的笔记或注释。 若要添加或更改标记,必须替换资源组的标记集合。 若要删除标记,请在 Get-AzureRmResourceGroup 中输入当前应用于资源组的所有标记的哈希表,但要删除的标记除外。 若要从资源组中删除所有标记,请指定空哈希表: @{}

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

输入

None

输出

Microsoft.Azure.Commands.Resources.Models.PSResourceGroup