Update-AzPolicySetDefinition

Referenz

Modul:: Az.Resources

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

Syntax

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

Beschreibung

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

Beispiele

Beispiel 1: Aktualisieren der Beschreibung einer Richtliniensatzdefinition

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

Der erste Befehl ruft mithilfe des Cmdlets Get-AzPolicySetDefinition eine Richtliniensatzdefinition ab. Der Befehl speichert dieses Objekt in der $PolicySetDefinition Variablen. Der zweite Befehl aktualisiert die Beschreibung der Richtliniensatzdefinition, die durch die ResourceId-Eigenschaft von $PolicySetDefinition identifiziert wird.

Beispiel 2: Aktualisieren der Metadaten einer Richtliniensatzdefinition

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

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

Beispiel 3: Aktualisieren der Gruppen einer Richtliniensatzdefinition

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

Mit diesem Befehl werden die Gruppen einer Richtliniensatzdefinition namens "VMPolicySetDefinition" aktualisiert.

Beispiel 4: Aktualisieren der Gruppen einer Richtliniensatzdefinition mithilfe einer Hashtabelle

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

Mit diesem Befehl werden die Gruppen einer Richtliniensatzdefinition namens "VMPolicySetDefinition" aus einer Hashtabelle aktualisiert.

Beispiel 5: [Backcompat] Aktualisieren der Metadaten einer Richtliniensatzdefinition

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

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

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
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:	SwitchParameter
Aliase:	cf
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	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
Aliase:	AzureRMContext, AzureCredential
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Description

Die Beschreibung der Richtliniensatzdefinition.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-DisplayName

Der Anzeigename der Richtliniensatzdefinition.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Id

Die Ressourcen-ID der zu aktualisierenden Richtliniendefinition.

Typ:	String
Aliase:	ResourceId
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-InputObject

Typ:	IPolicySetDefinition
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ManagementGroupName

Die ID der Verwaltungsgruppe.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Metadata

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

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Name

Der Name der zu aktualisierenden Richtliniensatzdefinition.

Typ:	String
Aliase:	PolicySetDefinitionName
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Parameter

Die Parameterdefinitionen für Parameter, die im Richtliniensatz verwendet werden. Die Schlüssel sind die Parameternamen.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-PolicyDefinition

Das Richtliniendefinitionsarray in JSON-Zeichenfolgenform.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-PolicyDefinitionGroup

Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben. Informationen zum Erstellen finden Sie im Abschnitt "NOTES" für POLICYDEFINITIONGROUP-Eigenschaften, und erstellen Sie eine Hashtabelle.

Typ:	String
Aliase:	GroupDefinition
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-SubscriptionId

Die ID des Zielabonnements.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-WhatIf

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

Typ:	SwitchParameter
Aliase:	wi
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

IPolicySetDefinition

String

Ausgaben