Get-AzPolicyDefinition

モジュール:
Az.Resources Module

ポリシー セットの定義を取得します。

構文

Name (既定) 

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

ManagementGroupName 

Get-AzPolicyDefinition
    -ManagementGroupName <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>]
    [-ManagementGroupName <String>]
    [-Builtin]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Custom 

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

Static 

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

Id 

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

説明

Get-AzPolicyDefinition コマンドレットは、ポリシー セット定義のコレクション、または名前または ID で識別される特定のポリシー セット定義を取得します。

例

例 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"

このコマンドは、id /providers/Microsoft を持つポリシー定義のバージョン 1.1.1 を取得します。Authorization/policyDefinitions/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 Policy定義のリーダーフレンドリな DisplayName プロパティを見つける必要がある場合に便利です。 Metadata プロパティを解析して、ポリシー定義のバージョン番号とカテゴリの割り当てを検出できます。

パラメーター

-Builtin

コマンドレットが組み込みのポリシー定義のみを返すようにします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Builtin
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Custom

コマンドレットがカスタム ポリシー定義のみを返すようにします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Custom
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-DefaultProfile

Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。

パラメーターのプロパティ

型:PSObject
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Id

取得するポリシー定義の完全な ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:リソースID

パラメーター セット

Id
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ListVersion

コマンドレットがカスタム ポリシー定義バージョンのみを返すようにします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ManagementGroupName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
SubscriptionId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
Id
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ManagementGroupName

管理グループの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ManagementGroupName
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Name

取得するポリシー定義の名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:PolicyDefinitionName

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ManagementGroupName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
SubscriptionId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Static

コマンドレットが静的ポリシー定義のみを返すようにします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Static
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-SubscriptionId

ターゲット サブスクリプションの ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SubscriptionId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Version

#.#.# 形式のポリシー定義のバージョン。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:PolicyDefinitionVersion

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ManagementGroupName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
SubscriptionId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
Id
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

SwitchParameter

String

出力

IPolicyDefinition