New-AzPolicyEnrollment

モジュール:
Az.Resources Module

ポリシー登録を作成します。

構文

Default (既定) 

New-AzPolicyEnrollment
    -Name <String>
    -Scope <String>
    [-AssignmentScopeValidation <String>]
    [-Description <String>]
    [-DisplayName <String>]
    [-Metadata <String>]
    [-PolicyAssignmentId <String>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-ResourceSelector <IResourceSelector[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

説明

この New-AzPolicyEnrollment コマンドレットは、指定されたスコープと名前を使用してポリシー登録を作成します。 ポリシー登録は、その範囲内にあるすべてのリソースに適用されます。 例えば、同じレベル以上のポリシー割り当てのためにリソースグループの範囲でポリシー登録を作成すると、そのリソースグループ内のすべての該当リソースに登録が適用されます。

例

例 1: サブスクリプション スコープでのポリシー登録

$Subscription = Get-AzSubscription -SubscriptionName 'Subscription01'
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -PolicyAssignmentId $Assignment.Id -Scope "/subscriptions/$($Subscription.Id)" -DisplayName 'VM Policy Enrollment'

最初のコマンドは、Get-AzSubscription コマンドレットを使用して Subscription01 という名前のサブスクリプションを取得し、$Subscription変数に格納します。 2 番目のコマンドは、Get-AzPolicyAssignment コマンドレットを使用して VirtualMachinePolicyAssignment という名前のポリシー割り当てを取得し、$Assignment変数に格納します。 割り当てには、EnforcementMode が [登録] に設定されている必要があります。 最後のコマンドは、サブスクリプション スコープ文字列で識別されるサブスクリプションのレベルで、$Assignmentで割り当てのポリシー登録を作成します。

例 2: 管理グループ スコープでのポリシー登録

$ManagementGroup = Get-AzManagementGroup -GroupName 'AManagementGroup'
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -PolicyAssignmentId $Assignment.Id -Scope $ManagementGroup.Id -Description 'Enrollment for VM policy at MG level'

最初のコマンドは、Get-AzManagementGroup コマンドレットを使用して AManagementGroup という名前の管理グループを取得し、$ManagementGroup変数に格納します。 2 番目のコマンドは、Get-AzPolicyAssignment コマンドレットを使用して VirtualMachinePolicyAssignment という名前のポリシー割り当てを取得し、$Assignment変数に格納します。 割り当てには、EnforcementMode が [登録] に設定されている必要があります。 最後のコマンドは、$ManagementGroupの Id プロパティによって識別される管理グループ スコープで、$Assignmentの割り当てのポリシー登録を作成します。

例 3: リソース セレクターを使用したポリシー登録

$subscription = (Get-AzContext).Subscription
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
$ResourceSelector = @{Name = "MyLocationSelector"; Selector = @(@{Kind = "resourceLocation"; In = @("eastus", "eastus2")})}
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -Scope "/subscriptions/$($subscription.Id)" -PolicyAssignmentId $Assignment.Id -ResourceSelector $ResourceSelector

最初のコマンドは、登録が作成されるサブスクリプション (現在使用されているサブスクリプション) を取得します。 2 番目のコマンドは、Get-AzPolicyAssignment コマンドレットを使用して VirtualMachinePolicyAssignment という名前のポリシー割り当てを取得し、$Assignment変数に格納します。 3 番目のコマンドは、登録を米国東部または米国東部 2 にあるリソースに制限するリソース セレクター オブジェクトを作成し、$ResourceSelector変数に格納します。 最後のコマンドは、$ResourceSelectorで指定されたリソース セレクターを使用して、$Assignmentで割り当てのポリシー登録を作成します。

パラメーター

-AssignmentScopeValidation

登録の検証は割り当て範囲内かその範囲内にあります。

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

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

パラメーター セット

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

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

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

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

パラメーター セット

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

-Description

保険加入の説明。

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

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

パラメーター セット

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

-DisplayName

保険加入の表示名。

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

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

パラメーター セット

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

-Metadata

保険加入のメタデータです。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。

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

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

パラメーター セット

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

-Name

保険加入名。

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

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:PolicyEnrollmentName

パラメーター セット

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

-PolicyAssignmentId

登録中の保険契約のID。

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

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

パラメーター セット

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

-PolicyDefinitionReferenceId

関連付けられたポリシー割り当てがポリシー セット (イニシアティブ) に対する場合、これを使用して、登録する必要があるポリシー セット内のポリシー定義のポリシー定義参照 ID を指定できます。 これらのIDはポリシーセット定義における部分集合 policyDefinitions[*].policyDefinitionReferenceId に対応します。 指定されて空でない場合は、参照されたポリシー定義のみに登録されます。 それ以外の場合は、ポリシー セット全体が登録されます。

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

型:

String[]

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

パラメーター セット

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

-ResourceSelector

リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。

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

型:

IResourceSelector[]

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

パラメーター セット

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

-Scope

ポリシー登録のスコープ。 有効なスコープは、管理グループ (形式: '/providers/Microsoft) です。Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}')

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

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

パラメーター セット

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

CommonParameters

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

出力

IPolicyEnrollment