Set-AzPolicySetDefinition

Referenz

Modul:: Az.Resources

Ändert eine Richtliniensatzdefinition.

Syntax

Set-AzPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   [-GroupDefinition <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   -ManagementGroupName <String>
   [-GroupDefinition <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   -SubscriptionId <Guid>
   [-GroupDefinition <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzPolicySetDefinition
   -Id <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   [-GroupDefinition <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzPolicySetDefinition
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   -InputObject <PsPolicySetDefinition>
   [-GroupDefinition <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzPolicySetDefinition ändert eine Richtliniendefinition.

Beispiele

Beispiel 1: Aktualisieren der Beschreibung einer Richtliniensatzdefinition

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

Der erste Befehl ruft eine Richtliniensatzdefinition mithilfe des Cmdlets "Get-AzPolicySetDefinition" 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

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

Name                  : VMPolicySetDefinition
ResourceId            : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition
ResourceName          : VMPolicySetDefinition
ResourceType          : Microsoft.Authorization/policySetDefinitions
SubscriptionId        : 11111111-1111-1111-1111-111111111111
Properties            : @{displayName=VMPolicySetDefinition; policyType=Custom; metadata=; parameters=; policyDefinitions=System.Object[]}
PolicySetDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition

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

Set-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" }
Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

Mit diesem Befehl werden die Gruppen einer Richtliniensatzdefinition namens "VMPolicySetDefinition" mithilfe einer Hashtabelle aktualisiert, um die Gruppen zu erstellen.

Parameter

-ApiVersion

Wenn festgelegt, gibt die Version der zu verwendenden Ressourcenanbieter-API an. Wenn nicht angegeben, wird die API-Version automatisch als neueste verfügbare Version bestimmt.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Die Beschreibung für die Richtliniensatzdefinition.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DisplayName

Der Anzeigename für die Richtliniensatzdefinition.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GroupDefinition

Die Richtliniendefinitionsgruppen der aktualisierten Richtliniensatzdefinition. Dies kann entweder ein Pfad zu einer Datei sein, die die Gruppen enthält, oder die Gruppen als JSON-Zeichenfolge.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

Die vollqualifizierte Richtliniendefinitions-ID, einschließlich des Abonnements. z. B. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

Type:	String
Aliases:	ResourceId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Das Richtliniensatzdefinitionsobjekt, das aktualisiert werden soll, das von einem anderen Cmdlet ausgegeben wurde.

Type:	PsPolicySetDefinition
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementGroupName

Der Name der Verwaltungsgruppe der zu aktualisierenden Richtliniensatzdefinition.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Metadata

Die Metadaten der aktualisierten Richtliniensatzdefinition. Dies kann ein Pfad zu einem Dateinamen sein, der die Metadaten enthält, oder die Metadaten als JSON-Zeichenfolge.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Der Name der Richtliniensatzdefinition.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Parameter

Die Parameterdeklaration der aktualisierten Richtliniensatzdefinition. Dies kann entweder ein Pfad zu einem Dateinamen oder URI sein, der die Parameterdeklaration enthält, oder die Parameterdeklaration als JSON-Zeichenfolge.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PolicyDefinition

Die Richtliniendefinitionen. Dies kann entweder ein Pfad zu einem Dateinamen sein, der die Richtliniendefinitionen enthält, oder die Richtliniendefinitionen als JSON-Zeichenfolge.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

Wenn festgelegt, gibt an, dass das Cmdlet Vorabversionen von API-Versionen verwenden soll, wenn automatisch bestimmt wird, welche Version verwendet werden soll.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Die Abonnement-ID der zu aktualisierenden Richtliniensatzdefinition.

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Required:	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.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Eingaben

String

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Ausgaben

PSObject