Get-AzPolicyDefinition

Moduł:

Az.Resources

Pobiera definicje zestawu zasad.

Składnia

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

Opis

Polecenie cmdlet Get-AzPolicyDefinition pobiera kolekcję definicji zestawu zasad lub określoną definicję zestawu zasad zidentyfikowaną przez nazwę lub identyfikator.

Przykłady

Przykład 1. Pobieranie wszystkich definicji zasad

Get-AzPolicyDefinition

To polecenie pobiera wszystkie definicje zasad.

Przykład 2. Pobieranie definicji zasad z bieżącej subskrypcji według nazwy

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

To polecenie pobiera definicję zasad o nazwie VMPolicyDefinition z bieżącej subskrypcji domyślnej.

Przykład 3. Pobieranie definicji zasad z grupy zarządzania według nazwy

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

To polecenie pobiera definicję zasad o nazwie VMPolicyDefinition z grupy zarządzania o nazwie Dept42.

Przykład 4. Pobieranie wszystkich wbudowanych definicji zasad z subskrypcji

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

To polecenie pobiera wszystkie wbudowane definicje zasad z subskrypcji o identyfikatorze 3bf44b72-c631-427a-b8c8-53e2595398ca.

Przykład 5. Pobieranie definicji zasad z danej kategorii

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

To polecenie pobiera wszystkie definicje zasad w kategorii Tagi.

Przykład 6. Pobieranie nazwy wyświetlanej, opisu, typu zasad i metadanych wszystkich definicji zasad sformatowanych jako lista

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

To polecenie jest przydatne, gdy trzeba znaleźć przyjazną dla czytelnika właściwość DisplayName definicji usługi Azure Policy. Właściwość Metadata można przeanalizować, aby odnaleźć numer wersji definicji zasad i przypisanie kategorii.

Przykład 7: [Backcompat] Pobieranie nazwy wyświetlanej, opisu, typu zasad i metadanych wszystkich definicji zasad sformatowanych jako lista

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

To polecenie jest przydatne, gdy trzeba znaleźć przyjazną dla czytelnika właściwość DisplayName definicji usługi Azure Policy. Właściwość Metadata można przeanalizować, aby odnaleźć numer wersji definicji zasad i przypisanie kategorii.

Parametry

-BackwardCompatible

Powoduje, że polecenie cmdlet zwraca artefakty przy użyciu starszego formatu umieszczania właściwości specyficznych dla zasad w obiekcie torby właściwości.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Builtin

Powoduje, że polecenie cmdlet zwraca tylko wbudowane definicje zasad.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Custom

Powoduje, że polecenie cmdlet zwraca tylko niestandardowe definicje zasad.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:	PSObject
Aliasy:	AzureRMContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Id

Pełny identyfikator definicji zasad do pobrania.

Typ:	String
Aliasy:	ResourceId
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ListVersion

Powoduje, że polecenie cmdlet zwraca tylko niestandardowe definicje zasad.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ManagementGroupName

Nazwa grupy zarządzania.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Name

Nazwa definicji zasad do pobrania.

Typ:	String
Aliasy:	PolicyDefinitionName
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Static

Powoduje, że polecenie cmdlet zwraca tylko definicje zasad statycznych.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SubscriptionId

Identyfikator subskrypcji docelowej.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Version

Wersja definicji zasad w formacie #.#.#

Typ:	String
Aliasy:	PolicyDefinitionVersion
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

SwitchParameter

String

Dane wyjściowe

IPolicyDefinition