Set-AzResourceGroup

  • Ссылка
Модуль:
Az.Resources

Изменяет группу ресурсов.

Синтаксис

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

Описание

Командлет Set-AzResourceGroup изменяет свойства группы ресурсов. Этот командлет можно использовать для добавления, изменения или удаления тегов Azure, примененных к группе ресурсов. Укажите параметр Name, чтобы определить группу ресурсов и параметр Тега, чтобы изменить теги. Этот командлет нельзя использовать для изменения имени группы ресурсов.

Примеры

Пример 1. Применение тега к группе ресурсов

Set-AzResourceGroup -Name "ContosoRG" -Tag @{Department="IT"}

Эта команда применяет тег Отдела со значением ИТ-отдела к группе ресурсов, которая не имеет существующих тегов.

Пример 2. Добавление тегов в группу ресурсов

$Tags = (Get-AzResourceGroup -Name "ContosoRG").Tags
$Tags
$Tags += @{"Status"="Approved"; "FY2016"=$null}
Set-AzResourceGroup -Name "ContosoRG" -Tag $Tags
(Get-AzResourceGroup -Name "ContosoRG").Tags

В этом примере добавлен тег состояния со значением "Утверждено" и тегом FY2016 в группу ресурсов с существующими тегами. Поскольку указанные теги заменяют существующие теги, необходимо включить существующие теги в новую коллекцию тегов или потерять их. Первая команда получает группу ресурсов ContosoRG и использует метод dot для получения значения свойства Tags. Команда сохраняет теги в переменной $Tags. Вторая команда получает теги в переменной $Tags. Третья команда использует оператор назначения += для добавления тегов Status и FY2016 в массив тегов в переменной $Tags. Четвертая команда использует параметр Tag в Set-AzResourceGroup для применения тегов в переменной $Tags к группе ресурсов ContosoRG. Пятая команда получает все теги, примененные к группе ресурсов ContosoRG. В выходных данных показано, что группа ресурсов имеет тег "Отдел" и два новых тега, "Состояние" и "FY2015".

Пример 3. Удаление всех тегов для группы ресурсов

Set-AzResourceGroup -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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Указывает идентификатор группы ресурсов для изменения.

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

-Name

Указывает имя группы ресурсов для изменения.

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

-Pre

Указывает, что этот командлет рассматривает версии 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-AzResource и Get-AzResourceGroup для поиска ресурсов и групп по имени тега или имени и значению. Теги можно использовать для классификации ресурсов, таких как отдел или центр затрат, или для отслеживания заметок или комментариев о ресурсах. Чтобы добавить или изменить тег, необходимо заменить коллекцию тегов для группы ресурсов. Чтобы удалить тег, введите хэш-таблицу со всеми тегами, примененными к группе ресурсов, из Get-AzResourceGroup, за исключением тега, который требуется удалить. Чтобы удалить все теги из группы ресурсов, укажите пустую хэш-таблицу: @{}

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

Входные данные

String

Hashtable

Выходные данные

PSResourceGroup