Freigeben über


Update-AzPolicyDefinition

Dieser Vorgang aktualisiert eine vorhandene Richtliniendefinition in der angegebenen Abonnement- oder Verwaltungsgruppe mit dem angegebenen Namen.

Syntax

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>]

Beschreibung

Dieser Vorgang aktualisiert eine vorhandene Richtliniendefinition in der angegebenen Abonnement- oder Verwaltungsgruppe mit dem angegebenen Namen.

Beispiele

Beispiel 1: Aktualisieren der Beschreibung einer Richtliniendefinition

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

Der erste Befehl ruft eine Richtliniendefinition namens "VMPolicyDefinition" mithilfe des Cmdlets "Get-AzPolicyDefinition" ab. Der Befehl speichert dieses Objekt in der $PolicyDefinition Variablen. Der zweite Befehl aktualisiert die Beschreibung der Richtliniendefinition, die durch die ResourceId-Eigenschaft von $PolicyDefinition identifiziert wird.

Beispiel 2: Aktualisieren des Modus einer Richtliniendefinition

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

Mit diesem Befehl wird die Richtliniendefinition namens "VMPolicyDefinition" mithilfe des Cmdlets "Update-AzPolicyDefinition" aktualisiert, um seine Moduseigenschaft auf "All" festzulegen.

Beispiel 3: Aktualisieren der Metadaten einer Richtliniendefinition

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

Mit diesem Befehl werden die Metadaten einer Richtliniendefinition namens "VMPolicyDefinition" aktualisiert, um anzugeben, dass die Kategorie "Virtueller Computer" lautet.

Beispiel 3: [Backcompat] Aktualisieren des Modus einer Richtliniendefinition

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

Mit diesem Befehl wird die Richtliniendefinition namens "VMPolicyDefinition" mithilfe des Set-AzPolicyDefinition-Alias des Cmdlets "Update-AzPolicyDefinition" aktualisiert, um die Moduseigenschaft auf "All" festzulegen.

Parameter

-BackwardCompatible

Bewirkt, dass cmdlet Artefakte mithilfe von richtlinienspezifischen Eigenschaften im Legacyformat in einem Eigenschaftenbehälterobjekt zurückgibt.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliases:cf
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Der Parameter DefaultProfile ist nicht funktionsfähig. Verwenden Sie den Parameter "SubscriptionId", wenn sie verfügbar ist, wenn Sie das Cmdlet für ein anderes Abonnement ausführen.

Typ:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Die Beschreibung der Richtliniendefinition.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayName

Der Anzeigename der Richtliniendefinition.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

Die Ressourcen-ID der zu aktualisierenden Richtliniendefinition.

Typ:String
Aliases:ResourceId
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Typ:IPolicyDefinition
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

Die ID der Verwaltungsgruppe.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-Metadata

Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Mode

Der Richtliniendefinitionsmodus. Einige Beispiele sind "All", "Indexed", "Microsoft.KeyVault.Data".

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Der Name der zu aktualisierenden Richtliniendefinition.

Typ:String
Aliases:PolicyDefinitionName
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameter

Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

-Policy

Die Richtlinienregel.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

Hierbei handelt es sich um die ID des Zielabonnements.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliases:wi
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

IPolicyDefinition

String

Ausgaben

IPolicyDefinition

Hinweise

ALIASE

Set-AzPolicyDefinition