Get-AzureRmPolicySetDefinition

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

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Get-AzureRmPolicySetDefinition
   [-Name <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmPolicySetDefinition
   [-Name <String>]
   -ManagementGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmPolicySetDefinition
   [-Name <String>]
   -SubscriptionId <Guid>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmPolicySetDefinition
   -Id <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmPolicySetDefinition
   [-ManagementGroupName <String>]
   [-SubscriptionId <Guid>]
   [-Builtin]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmPolicySetDefinition
   [-ManagementGroupName <String>]
   [-SubscriptionId <Guid>]
   [-Custom]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

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

例 1: すべてのポリシー セット定義を取得する

PS C:\> Get-AzureRmPolicySetDefinition

このコマンドは、すべてのポリシー セット定義を取得します。

例 2: 現在のサブスクリプションから名前でポリシー セット定義を取得する

PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition'

このコマンドは、現在の既定のサブスクリプションから VMPolicySetDefinition という名前のポリシー セット定義を取得します。

例 3: サブスクリプションから名前でポリシー セット定義を取得する

PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition' -subscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca'

このコマンドは、ID 3bf44b72-c631-427a-b8c8-53e2595398ca のサブスクリプションから VMPolicySetDefinition という名前のポリシー定義を取得します。

例 4: 管理グループからすべてのカスタム ポリシー セット定義を取得する

PS C:\> Get-AzureRmPolicySetDefinition -ManagementGroupName 'Dept42' -Custom

このコマンドは、Dept42 という名前の管理グループからすべてのカスタム ポリシー セット定義を取得します。

パラメーター

-ApiVersion

設定すると、使用するリソース プロバイダー API のバージョンを示します。 指定しない場合、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:AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Id

サブスクリプションを含む完全修飾ポリシー セット定義 ID。 例: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

型: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

入力

String

Nullable<T>[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

出力

PSObject