Set-AzResourceGroup

  • Référence
Module:
Az.Resources

Modifie un groupe de ressources.

Syntaxe

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

L’applet de commande Set-AzResourceGroup modifie les propriétés d’un groupe de ressources. Vous pouvez utiliser cette applet de commande pour ajouter, modifier ou supprimer les balises Azure appliquées à un groupe de ressources. Spécifiez le paramètre Name pour identifier le groupe de ressources et le paramètre Tag pour modifier les balises. Vous ne pouvez pas utiliser cette applet de commande pour modifier le nom d’un groupe de ressources.

Exemples

Exemple 1 : Appliquer une balise à un groupe de ressources

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

Cette commande applique une balise Department avec une valeur informatique à un groupe de ressources qui n’a pas de balises existantes.

Exemple 2 : Ajouter des balises à un groupe de ressources

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

Cet exemple ajoute une balise Status avec une valeur Approuvée et une balise FY2016 à un groupe de ressources qui a des balises existantes. Étant donné que les balises que vous spécifiez remplacent les balises existantes, vous devez inclure les balises existantes dans la nouvelle collection de balises ou vous les perdrez. La première commande obtient le groupe de ressources ContosoRG et utilise la méthode dot pour obtenir la valeur de sa propriété Tags. La commande stocke les balises dans la variable $Tags. La deuxième commande obtient les balises dans la variable $Tags. La troisième commande utilise l’opérateur d’affectation += pour ajouter les balises Status et FY2016 au tableau d’étiquettes dans la variable $Tags. La quatrième commande utilise le paramètre Tag de Set-AzResourceGroup pour appliquer les balises dans la variable $Tags au groupe de ressources ContosoRG. La cinquième commande obtient toutes les balises appliquées au groupe de ressources ContosoRG. La sortie indique que le groupe de ressources a la balise Department et les deux nouvelles balises, Status et FY2015.

Exemple 3 : Supprimer toutes les balises d’un groupe de ressources

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

Cette commande spécifie le paramètre Tag avec une valeur de table de hachage vide pour supprimer toutes les balises du groupe de ressources ContosoRG.

Paramètres

-ApiVersion

Spécifie la version de l’API prise en charge par le fournisseur de ressources. Vous pouvez spécifier une version différente de la version par défaut.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Id

Spécifie l’ID du groupe de ressources à modifier.

Type:String
Alias:ResourceGroupId, ResourceId
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

Spécifie le nom du groupe de ressources à modifier.

Type:String
Alias:ResourceGroupName
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Pre

Indique que cette applet de commande prend en compte les versions d’API en préversion lorsqu’elle détermine automatiquement la version à utiliser.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tag

Paires clé-valeur sous la forme d’une table de hachage. Par exemple : @{key0="value0 » ; key1=$null ; key2="value2"} Une balise est une paire nom-valeur que vous pouvez créer et appliquer aux ressources et aux groupes de ressources. Après avoir affecté des balises à des ressources et des groupes, vous pouvez utiliser le paramètre Tag de Get-AzResource et Get-AzResourceGroup pour rechercher des ressources et des groupes par nom ou nom et valeur de balise. Vous pouvez utiliser des balises pour catégoriser vos ressources, telles que par service ou centre de coûts, ou pour suivre les notes ou commentaires sur les ressources. Pour ajouter ou modifier une balise, vous devez remplacer la collection d’étiquettes pour le groupe de ressources. Pour supprimer une balise, entrez une table de hachage avec toutes les balises actuellement appliquées au groupe de ressources, à l’exception de la balise que vous souhaitez supprimer. Pour supprimer toutes les balises d’un groupe de ressources, spécifiez une table de hachage vide : @{}.

Type:Hashtable
Alias:Tags
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

String

Hashtable

Sorties

PSResourceGroup