Update-AzPolicyEnrollment

モジュール:
Az.Resources Module

この操作により、新しく指定されたプロパティを使用してポリシー登録が更新されます。

構文

UpdateByNameAndScope (既定) 

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

UpdateByInputObject 

Update-AzPolicyEnrollment
    -InputObject <IPolicyEnrollment>
    [-Description <String>]
    [-DisplayName <String>]
    [-AssignmentScopeValidation <String>]
    [-ResourceSelector <IResourceSelector[]>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-Metadata <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

UpdateById 

Update-AzPolicyEnrollment
    -Id <String>
    [-Description <String>]
    [-DisplayName <String>]
    [-AssignmentScopeValidation <String>]
    [-ResourceSelector <IResourceSelector[]>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-Metadata <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

説明

Update-AzPolicyEnrollment コマンドレットは、新しく指定されたプロパティを使用してポリシー登録を更新します。

指定されていないプロパティは、既存の登録から保持されます。

例

例 1: 表示名を更新する

$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope $ResourceGroup.ResourceId
Update-AzPolicyEnrollment -Id $PolicyEnrollment.Id -DisplayName 'Enrollment for VM location policy'

最初のコマンドは、Get-AzResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。 このコマンドは、そのオブジェクトを $ResourceGroup 変数に格納します。 2 番目のコマンドは、Get-AzPolicyEnrollment コマンドレットを使用して PolicyEnrollment07 という名前のポリシー登録を取得します。 このコマンドは、そのオブジェクトを $PolicyEnrollment 変数に格納します。 最後のコマンドは、$PolicyEnrollmentの Id プロパティによって識別されるポリシー登録の表示名を更新します。

例 2: パイプライン経由で更新する

$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope "/subscriptions/$((Get-AzContext).Subscription.Id)"
$PolicyEnrollment.DisplayName = 'Updated VM Enrollment'
$PolicyEnrollment | Update-AzPolicyEnrollment

最初のコマンドは、Get-AzPolicyEnrollment コマンドレットを使用して PolicyEnrollment07 という名前のポリシー登録を取得し、$PolicyEnrollment変数に格納します。 2 番目のコマンドは、$PolicyEnrollment オブジェクトに新しい表示名を設定します。 最後のコマンドは、変更されたオブジェクトをパイプ処理して Update-AzPolicyEnrollment 変更を保持します。

例 3: リソース セレクターを更新する

$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$ResourceSelector = @{Name = "MyLocationSelector"; Selector = @(@{Kind = "resourceLocation"; NotIn = @("eastus", "eastus2")})}
Update-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -Scope $ResourceGroup.ResourceId -ResourceSelector $ResourceSelector

最初のコマンドは、Get-AzResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。 2 番目のコマンドは、登録を米国東部または米国東部 2 以外の場所のリソースに制限するリソース セレクター オブジェクトを作成し、$ResourceSelector変数に格納します。 最後のコマンドは、VirtualMachinePolicyEnrollment という名前のポリシー登録を、$ResourceSelectorで指定されたリソース セレクターで更新します。

パラメーター

-AssignmentScopeValidation

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

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

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

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値: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
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-DisplayName

保険加入の表示名。

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

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

パラメーター セット

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

-Id

更新するポリシー登録の ID。 '{scope}/providers/Microsoft の形式を使用します。Authorization/policyEnrollments/{policyEnrollmentName}'。

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

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

パラメーター セット

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

-InputObject

更新するポリシー登録オブジェクト。

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

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

パラメーター セット

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

-Metadata

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

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

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

パラメーター セット

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

-Name

保険加入名。

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

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

パラメーター セット

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

-PolicyDefinitionReferenceId

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

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

型:

String[]

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

パラメーター セット

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

-ResourceSelector

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

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

型:

IResourceSelector[]

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

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値: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

パラメーター セット

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

CommonParameters

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

入力

IPolicyEnrollment

IResourceSelector

String

String

出力

IPolicyEnrollment