Get-AzPolicyDefinition

  • Referenz
Modul:
Az.Resources

Ruft Richtliniensatzdefinitionen ab.

Syntax

Get-AzPolicyDefinition
   [-Name <String>]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   -ManagementGroupName <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   -SubscriptionId <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   [-Id <String>]
   [-BackwardCompatible]
   -Version <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   [-Id <String>]
   [-ListVersion]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   -Id <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Builtin]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Custom]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Static]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Beschreibung

Das Cmdlet "Get-AzPolicyDefinition " ruft eine Sammlung von Richtliniensatzdefinitionen oder einer bestimmten Richtliniensatzdefinition ab, die anhand des Namens oder der ID identifiziert wird.

Beispiele

Beispiel 1: Abrufen aller Richtliniendefinitionen

Get-AzPolicyDefinition

Dieser Befehl ruft alle Richtliniendefinitionen ab.

Beispiel 2: Abrufen der Richtliniendefinition aus dem aktuellen Abonnement anhand des Namens

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

Dieser Befehl ruft die Richtliniendefinition mit dem Namen "VMPolicyDefinition" aus dem aktuellen Standardabonnement ab.

Beispiel 3: Abrufen der Richtliniendefinition aus der Verwaltungsgruppe anhand des Namens

Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42'

Dieser Befehl ruft die Richtliniendefinition mit dem Namen "VMPolicyDefinition" aus der Verwaltungsgruppe "Dept42" ab.

Beispiel 4: Abrufen aller integrierten Richtliniendefinitionen aus dem Abonnement

Get-AzPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin

Dieser Befehl ruft alle integrierten Richtliniendefinitionen aus dem Abonnement mit der ID 3bf44b72-c631-427a-b8c8-53e2595398ca ab.

Beispiel 5: Abrufen von Richtliniendefinitionen aus einer bestimmten Kategorie

Get-AzPolicyDefinition | Where-Object {$_.Properties.metadata.category -eq 'Tags'}

Dieser Befehl ruft alle Richtliniendefinitionen in den Kategorietags ab.

Beispiel 6: Abrufen des Anzeigenamens, der Beschreibung, des Richtlinientyps und der Metadaten aller Als Liste formatierten Richtliniendefinitionen

Get-AzPolicyDefinition | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Dieser Befehl ist nützlich, wenn Sie die anzeigefreundliche DisplayName-Eigenschaft einer Azure-Richtliniendefinition finden müssen. Sie können die Metadata-Eigenschaft analysieren, um die Versionsnummer und Kategoriezuweisung der Richtliniendefinition zu ermitteln.

Beispiel 7: [Backcompat] Abrufen des Anzeigenamens, der Beschreibung, des Richtlinientyps und der Metadaten aller Richtliniendefinitionen, die als Liste formatiert sind

Get-AzPolicyDefinition -BackwardCompatible | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Dieser Befehl ist nützlich, wenn Sie die anzeigefreundliche DisplayName-Eigenschaft einer Azure-Richtliniendefinition finden müssen. Sie können die Metadata-Eigenschaft analysieren, um die Versionsnummer und Kategoriezuweisung der Richtliniendefinition zu ermitteln.

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

-Builtin

Führt dazu, dass cmdlet nur integrierte Richtliniendefinitionen zurückgibt.

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

-Custom

Bewirkt, dass cmdlet nur benutzerdefinierte Richtliniendefinitionen zurückgibt.

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

-DefaultProfile

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

Typ:PSObject
Aliase:AzureRMContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Id

Die vollständige ID der abzurufenden Richtliniendefinition.

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

-ListVersion

Bewirkt, dass cmdlet nur benutzerdefinierte Richtliniendefinitionen zurückgibt.

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

-ManagementGroupName

Der Name der Verwaltungsgruppe.

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

-Name

Der Name der abzurufenden Richtliniendefinition.

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

-Static

Führt dazu, dass cmdlet nur statische Richtliniendefinitionen zurückgibt.

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

-SubscriptionId

Hierbei handelt es sich um die ID des Zielabonnements.

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

-Version

Die Richtliniendefinitionsversion im #.#.#.#-Format.

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

Eingaben

SwitchParameter

String

Ausgaben

IPolicyDefinition