Update-AzPolicyDefinition

Référence

Module:: Az.Resources

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

Syntaxe

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Cette opération met à jour une définition de stratégie 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 de stratégie

$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

La première commande obtient une définition de stratégie nommée VMPolicyDefinition à l’aide de l’applet de commande Get-AzPolicyDefinition. La commande stocke cet objet dans la variable $PolicyDefinition. La deuxième commande met à jour la description de la définition de stratégie identifiée par la propriété ResourceId de $PolicyDefinition.

Exemple 2 : Mettre à jour le mode d’une définition de stratégie

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Cette commande met à jour la définition de stratégie nommée VMPolicyDefinition à l’aide de l’applet de commande Update-AzPolicyDefinition pour définir sa propriété de mode sur « All ».

Exemple 3 : Mettre à jour les métadonnées d’une définition de stratégie

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'

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

Exemple 3 : [Backcompat] Mettre à jour le mode d’une définition de stratégie

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Cette commande met à jour la définition de stratégie nommée VMPolicyDefinition à l’aide de l’alias Set-AzPolicyDefinition de l’applet de commande Update-AzPolicyDefinition pour définir sa propriété de mode sur « All ».

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 de stratégie.

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 de stratégie.

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:	IPolicyDefinition
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 de stratégie. 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

-Mode

Mode de définition de stratégie. Voici quelques exemples : All, Indexed, Microsoft.KeyVault.Data.

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 de stratégie à mettre à jour.

Type:	String
Alias:	PolicyDefinitionName
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 la règle de stratégie. 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:	False
Accepter les caractères génériques:	False

-Policy

Règle de stratégie.

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

-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

IPolicyDefinition

String

Sorties