Set-AzureRmResourceGroup
Modifica um grupo de recursos.
Aviso
O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.
Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.
Sintaxe
Set-AzureRmResourceGroup
[-Name] <String>
[-Tag] <Hashtable>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzureRmResourceGroup
[-Tag] <Hashtable>
[-Id] <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
O cmdlet Set-AzureRmResourceGroup 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 tags. Você não pode usar esse cmdlet para alterar o nome de um grupo de recursos.
Exemplos
Exemplo 1: Aplicar uma marca a um grupo de recursos
PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{Department="IT"}
Esse comando aplica uma marca de departamento 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
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
Este exemplo adiciona uma marca Status com um valor de Aprovado e uma marca FY2016 a um grupo de recursos que tem marcas existentes. Como as tags especificadas substituem as tags existentes, você deve incluir as tags existentes na nova coleção de tags 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 tags 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-AzureRmResourceGroup 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
PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{}
Esse 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 compatível com o provedor de recursos. Você pode especificar uma versão diferente da versão padrão.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure
Tipo: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Id
Especifica a ID do grupo de recursos a ser modificado.
Tipo: | String |
Aliases: | ResourceGroupId, ResourceId |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Name
Especifica o nome do grupo de recursos a ser modificado.
Tipo: | String |
Aliases: | ResourceGroupName |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Pre
Indica que esse cmdlet considera versões de API de pré-lançamento quando determina automaticamente qual versão usar.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Tag
Pares de chave-valor na forma de uma tabela de hash. Por exemplo: @{key0="value0"; chave1=$null; key2="value2"} Uma marca é 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-AzureRmResource e Get-AzureRmResourceGroup 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 rastrear anotações ou comentários sobre os recursos.
Para adicionar ou alterar uma tag, você deve substituir a coleção de tags do grupo de recursos. Para excluir uma marca, insira uma tabela de hash com todas as marcas atualmente aplicadas ao grupo de recursos, de Get-AzureRmResourceGroup, exceto para a marca que você deseja excluir. Para excluir todas as tags de um grupo de recursos, especifique uma tabela de hash vazia: @{}
.
Tipo: | Hashtable |
Aliases: | Tags |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
Entradas
None
Saídas
Microsoft.Azure.Commands.Resources.Models.PSResourceGroup