Get-AzPolicyDefinition
ポリシー定義を取得します。
構文
Get-AzPolicyDefinition
[-Name <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-Name <String>]
-ManagementGroupName <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-Name <String>]
-SubscriptionId <Guid>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
-Id <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-ManagementGroupName <String>]
[-SubscriptionId <Guid>]
[-Builtin]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-ManagementGroupName <String>]
[-SubscriptionId <Guid>]
[-Custom]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<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'}
このコマンドは、カテゴリ Tags 内のすべてのポリシー定義を取得します。
例 6: リストとして書式設定されたすべてのポリシー定義の表示名、説明、ポリシーの種類、およびメタデータを取得する
Get-AzPolicyDefinition | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List
このコマンドは、Azure Policy 定義のリーダーフレンドリな DisplayName プロパティを見つける必要がある場合に便利です。 Metadata プロパティを解析して、ポリシー定義のバージョン番号とカテゴリの割り当てを検出できます。
パラメーター
-ApiVersion
使用するリソース プロバイダー API のバージョンを指定します。 バージョンを指定しない場合、このコマンドレットは使用可能な最新バージョンを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Builtin
結果の一覧を組み込みのポリシー定義のみに制限します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Custom
結果の一覧をカスタム ポリシー定義のみに制限します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
このコマンドレットが取得するポリシー定義の完全修飾リソース ID を指定します。
型: | String |
Aliases: | ResourceId |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ManagementGroupName
取得するポリシー定義の管理グループの名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットが取得するポリシー定義の名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SubscriptionId
取得するポリシー定義のサブスクリプション ID。
型: | Nullable<T>[Guid] |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]