Update-AzPolicySetDefinition

Référence

Module:: Az.Resources

Cette opération met à jour une définition de jeu de stratégies existante dans l’abonnement ou le groupe d’administration donné avec le nom donné.

Syntaxe

Update-AzPolicySetDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      -InputObject <IPolicySetDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Cette opération met à jour une définition de jeu de stratégies existante dans l’abonnement ou le groupe d’administration donné avec le nom donné.

Exemples

Exemple 1 : Mettre à jour la description d’une définition d’ensemble de stratégies

$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

La première commande obtient une définition de jeu de stratégies à l’aide de l’applet de commande Get-AzPolicySetDefinition. La commande stocke cet objet dans la variable $PolicySetDefinition. La deuxième commande met à jour la description de la définition du jeu de stratégies identifiée par la propriété ResourceId de $PolicySetDefinition.

Exemple 2 : Mettre à jour les métadonnées d’une définition de jeu de stratégies

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Cette commande met à jour les métadonnées d’une définition de jeu de stratégies nommée VMPolicySetDefinition pour indiquer que sa catégorie est « Machine virtuelle ».

Exemple 3 : Mettre à jour les groupes d’une définition d’ensemble de stratégies

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

Cette commande met à jour les groupes d’une définition de jeu de stratégies nommée VMPolicySetDefinition.

Exemple 4 : Mettre à jour les groupes d’une définition de jeu de stratégies à l’aide d’une table de hachage

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

Cette commande met à jour les groupes d’une définition de jeu de stratégies nommée VMPolicySetDefinition à partir d’une table de hachage.

Exemple 5 : [Backcompat] Mettre à jour les métadonnées d’une définition de jeu de stratégies

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Cette commande met à jour les métadonnées d’une définition de jeu de stratégies nommée VMPolicySetDefinition pour indiquer que sa catégorie est « Machine virtuelle ».

Paramètres

-BackwardCompatible

Provoque le retour d’artefacts à l’aide d’un format hérité plaçant des propriétés propres à une stratégie dans un objet de conteneur de propriétés.

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

-Confirm

Vous demande une confirmation avant d’exécuter la commande cmdlet.

Type:	SwitchParameter
Alias:	cf
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

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Type:	PSObject
Alias:	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

-Description

Description de la définition du jeu de stratégies.

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

-DisplayName

Nom complet de la définition du jeu de stratégies.

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

-Id

ID de ressource de la définition de stratégie à mettre à jour.

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

-InputObject

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

-ManagementGroupName

ID du groupe d’administration.

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

-Metadata

Métadonnées de définition du jeu de stratégies. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur.

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

-Name

Nom de la définition du jeu de stratégies à mettre à jour.

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

-Parameter

Définitions de paramètres pour les paramètres utilisés dans l’ensemble de stratégies. Les clés sont les noms de paramètres.

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

-PolicyDefinition

Tableau de définition de stratégie sous forme de chaîne JSON.

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

-PolicyDefinitionGroup

Métadonnées décrivant les groupes de références de définition de stratégie dans la définition du jeu de stratégies. Pour construire, consultez la section NOTES pour les propriétés POLICYDEFINITIONGROUP et créez une table de hachage.

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

-SubscriptionId

ID de l’abonnement cible.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

IPolicySetDefinition

String

Sorties