Set-AzureRmPolicySetDefinition

Modul:

AzureRM.Resources

Ändert eine Richtliniensatzdefinition.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

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

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

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

Beschreibung

Das Cmdlet Set-AzureRmPolicySetDefinition ändert eine Richtliniendefinition.

Beispiele

Beispiel 1: Aktualisieren der Beschreibung einer Richtliniensatzdefinition

PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
PS C:\> Set-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

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

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

-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

-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 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 Zeichenfolge.

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

-PolicyDefinition

Die Richtliniensatzdefinition. Dies kann entweder ein Pfad zu einem Dateinamen sein, der die Richtliniendefinitionen enthält, oder die Richtliniensatzdefinition als 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, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Ausgaben

PSObject