Update-AzPolicyDefinition

リファレンス

モジュール:: Az.Resources

この操作により、指定されたサブスクリプションまたは管理グループ内の既存のポリシー定義が、指定された名前で更新されます。

構文

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

この操作により、指定されたサブスクリプションまたは管理グループ内の既存のポリシー定義が、指定された名前で更新されます。

例

例 1: ポリシー定義の説明を更新する

$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

最初のコマンドは、Get-AzPolicyDefinition コマンドレットを使用して、VMPolicyDefinition という名前のポリシー定義を取得します。このコマンドは、そのオブジェクトを $PolicyDefinition 変数に格納します。 2 番目のコマンドは、$PolicyDefinitionの ResourceId プロパティによって識別されるポリシー定義の説明を更新します。

例 2: ポリシー定義のモードを更新する

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

このコマンドは、Update-AzPolicyDefinition コマンドレットを使用して VMPolicyDefinition という名前のポリシー定義を更新し、その mode プロパティを 'All' に設定します。

例 3: ポリシー定義のメタデータを更新する

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'

このコマンドは、VMPolicyDefinition という名前のポリシー定義のメタデータを更新して、そのカテゴリが "仮想マシン" であることを示します。

例 3: [Backcompat] ポリシー定義のモードを更新する

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

このコマンドは、Update-AzPolicyDefinition コマンドレットの Set-AzPolicyDefinition エイリアスを使用して VMPolicyDefinition という名前のポリシー定義を更新し、その mode プロパティを 'All' に設定します。

パラメーター

-BackwardCompatible

プロパティバッグオブジェクトにポリシー固有のプロパティを配置する従来の形式を使用して、コマンドレットから成果物が返されます。

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

ポリシー定義の説明。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DisplayName

ポリシー定義の表示名。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

更新するポリシー定義のリソース ID。

型:	String
Aliases:	ResourceId
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

型:	IPolicyDefinition
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementGroupName

管理グループの ID。

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Metadata

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

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Mode

ポリシー定義モード。たとえば、All、Indexed、Microsoft.KeyVault.Data などです。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

更新するポリシー定義の名前。

型:	String
Aliases:	PolicyDefinitionName
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Parameter

ポリシー規則で使用されるパラメーターのパラメーター定義。キーはパラメーター名です。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Policy

ポリシールール。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SubscriptionId

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

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

IPolicyDefinition

String

出力