Set-AzResourceGroup

  • Referência
Módulo:
Az.Resources

Modifica um grupo de recursos.

Syntax

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

Description

O cmdlet Set-AzResourceGroup modifica as propriedades de um grupo de recursos. Você pode usar esse cmdlet para adicionar, alterar ou excluir as marcas do Azure aplicadas a um grupo de recursos. Especifique o parâmetro Name para identificar o grupo de recursos e o parâmetro Tag para modificar as marcas. Não é possível usar esse cmdlet para alterar o nome de um grupo de recursos.

Exemplos

Exemplo 1: Aplicar uma marca a um grupo de recursos

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

Esse comando aplica uma marca Department com um valor de IT a um grupo de recursos que não tem marcas existentes.

Exemplo 2: Adicionar marcas a um grupo de recursos

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

Este exemplo adiciona uma marca Status com um valor Approved e uma tag FY2016 a um grupo de recursos que tem marcas existentes. Como as marcas especificadas substituem as marcas existentes, você deve incluir as marcas existentes na nova coleção de marcas ou as perderá. O primeiro comando obtém o grupo de recursos ContosoRG e usa o método dot para obter o valor de sua propriedade Tags. O comando armazena as marcas na variável $Tags. O segundo comando obtém as tags na variável $Tags. O terceiro comando usa o operador de atribuição += para adicionar as tags Status e FY2016 à matriz de tags na variável $Tags. O quarto comando usa o parâmetro Tag de Set-AzResourceGroup para aplicar as marcas na variável $Tags ao grupo de recursos ContosoRG. O quinto comando obtém todas as marcas aplicadas ao grupo de recursos ContosoRG. A saída mostra que o grupo de recursos tem a marca Department e as duas novas tags, Status e FY2015.

Exemplo 3: Excluir todas as marcas de um grupo de recursos

Set-AzResourceGroup -Name "ContosoRG" -Tag @{}

Este comando especifica o parâmetro Tag com um valor de tabela de hash vazio para excluir todas as marcas do grupo de recursos ContosoRG.

Parâmetros

-ApiVersion

Especifica a versão da API que é suportada pelo provedor de recursos. Você pode especificar uma versão diferente da versão padrão.

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

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

-Id

Especifica a ID do grupo de recursos a ser modificado.

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

-Name

Especifica o nome do grupo de recursos a ser modificado.

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

-Pre

Indica que esse cmdlet considera versões de API de pré-lançamento quando determina automaticamente qual versão usar.

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

-Tag

Pares chave-valor na forma de uma tabela de hash. Por exemplo: @{key0="value0"; chave1=$null; key2="value2"} Uma tag é um par nome-valor que você pode criar e aplicar a recursos e grupos de recursos. Depois de atribuir marcas a recursos e grupos, você pode usar o parâmetro Tag de Get-AzResource e Get-AzResourceGroup para pesquisar recursos e grupos por nome de marca ou nome e valor. Você pode usar tags para categorizar seus recursos, como por departamento ou centro de custo, ou para controlar anotações ou comentários sobre os recursos. Para adicionar ou alterar uma marca, você deve substituir a coleção de marcas para o grupo de recursos. Para excluir uma marca, insira uma tabela de hash com todas as marcas atualmente aplicadas ao grupo de recursos, de Get-AzResourceGroup, exceto a marca que você deseja excluir. Para excluir todas as marcas de um grupo de recursos, especifique uma tabela de hash vazia: @{}.

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

Entradas

String

Hashtable

Saídas

PSResourceGroup