Get-AzPolicyDefinition

取得原則集定義。

語法

Name (預設值)

Get-AzPolicyDefinition
    [-Name <String>]
    [-ListVersion]
    [-Version <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ManagementGroupName

Get-AzPolicyDefinition
    -ManagementGroupId <String>
    [-Name <String>]
    [-ListVersion]
    [-Version <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

SubscriptionId

Get-AzPolicyDefinition
    -SubscriptionId <String>
    [-Name <String>]
    [-ListVersion]
    [-Version <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Builtin

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupId <String>]
    [-Builtin]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Custom

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupId <String>]
    [-Custom]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Static

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupId <String>]
    [-Static]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Id

Get-AzPolicyDefinition
    -Id <String>
    [-ListVersion]
    [-Version <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get-AzPolicyDefinition Cmdlet 會取得原則集定義的集合,或以名稱或識別碼識別的特定原則集定義。

範例

範例 1:取得所有原則定義

Get-AzPolicyDefinition

此命令會取得所有原則定義。

範例 2:依名稱從目前訂用帳戶取得原則定義

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

此命令會從目前的預設訂用帳戶取得名為 VMPolicyDefinition 的原則定義。

範例 3:依名稱從管理群組取得原則定義

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

此命令會從名為 Dept42 的管理群組取得名為 VMPolicyDefinition 的原則定義。

範例 4:從訂用帳戶取得所有內建原則定義

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

此命令從ID為3bf44b72-c631-427a-b8c8-53e2595398ca的訂閱中獲取所有內置策略定義。

範例 5:從指定類別取得原則定義

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

此命令會取得 標籤類別中的所有原則定義。

範例 6:透過 ID 取得特定的政策定義版本

Get-AzPolicyDefinition -Id '/providers/Microsoft.Authorization/policyDefinitions/36fd7371-8eb7-4321-9c30-a7100022d048' -Version "1.1.1"

此指令取得政策定義版本 1.1.1,ID 為 /providers/Microsoft。授權/政策定義/36fd7371-8eb7-4321-9c30-a7100022d048。

範例 7:依名稱取得所有政策定義版本

Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ListVersion

此指令會從目前預設訂閱中取得名為 VMPolicyDefinition 的所有政策定義版本。

範例 8:將所有政策定義的顯示名稱、描述、政策類型及元資料格式化為清單

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

當你需要找到Azure 原則定義中對讀者友善的 DisplayName 屬性時,這個指令非常有用。 您可以剖析 Metadata 屬性,以探索原則定義的版本號碼和類別指派。

參數

-Builtin

導致 Cmdlet 只傳回內建原則定義。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Builtin
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Custom

導致 Cmdlet 只傳回自訂原則定義。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Custom
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DefaultProfile

用於與 Azure 通訊的憑證、帳號、租戶和訂閱。

參數屬性

類型:PSObject
預設值:None
支援萬用字元:False
不要顯示:False
別名:AzureRMContext, AzureCredential

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Id

要取得的原則定義的完整 ID。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:資源識別碼

參數集

Id
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-ListVersion

會導致 cmdlet 只回傳自訂政策定義版本。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Name
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
ManagementGroupName
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
SubscriptionId
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
Id
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-ManagementGroupId

管理群組的名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:管理群組名稱

參數集

ManagementGroupName
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Name

要取得的原則定義名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:原則定義名稱

參數集

Name
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
ManagementGroupName
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
SubscriptionId
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Static

導致 Cmdlet 只傳回靜態原則定義。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Static
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-SubscriptionId

目標訂用帳戶的標識碼。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

SubscriptionId
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Version

#.#.# 格式的原則定義版本。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:原則定義版本

參數集

Name
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
ManagementGroupName
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
SubscriptionId
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False
Id
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

SwitchParameter

String

輸出

IPolicyDefinition