Update-AzPolicyDefinition

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

構文

Name (既定)

Update-AzPolicyDefinition
    -Name <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-Policy <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Mode <String>]
    [-Version <String>]
    [-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
    [-ExternalEvaluationEnforcementSettingResultLifespan <String>]
    [-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
    [-EndpointSettingKind <String>]
    [-EndpointSettingDetail <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SubscriptionId

Update-AzPolicyDefinition
    -Name <String>
    -SubscriptionId <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-Policy <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Mode <String>]
    [-Version <String>]
    [-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
    [-ExternalEvaluationEnforcementSettingResultLifespan <String>]
    [-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
    [-EndpointSettingKind <String>]
    [-EndpointSettingDetail <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ManagementGroupName

Update-AzPolicyDefinition
    -Name <String>
    -ManagementGroupName <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-Policy <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Mode <String>]
    [-Version <String>]
    [-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
    [-ExternalEvaluationEnforcementSettingResultLifespan <String>]
    [-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
    [-EndpointSettingKind <String>]
    [-EndpointSettingDetail <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Id

Update-AzPolicyDefinition
    -Id <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Mode <String>]
    [-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
    [-ExternalEvaluationEnforcementSettingResultLifespan <String>]
    [-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
    [-EndpointSettingKind <String>]
    [-EndpointSettingDetail <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Update-AzPolicyDefinition
    -InputObject <IPolicyDefinition>
    [-DisplayName <String>]
    [-Description <String>]
    [-Policy <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Mode <String>]
    [-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
    [-ExternalEvaluationEnforcementSettingResultLifespan <String>]
    [-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
    [-EndpointSettingKind <String>]
    [-EndpointSettingDetail <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

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

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

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

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

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

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

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

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

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

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

例 4: ポリシー ファイルを使用して古いバージョンを追加するようにポリシー定義を更新する

Update-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Version '1.1.0'

このコマンドは、C:\LocationPolicy.json で指定されたポリシー規則を含むバージョン 1.1.0 を追加することで、LocationDefinition という名前の既存のポリシー定義を更新します。

パラメーター

-Confirm

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

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

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

パラメーター セット

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

-DefaultProfile

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

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

型:PSObject
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases: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

-EndpointSettingDetail

エンドポイントの詳細。

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

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

パラメーター セット

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

-EndpointSettingKind

エンドポイントの種類。

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

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

パラメーター セット

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

-ExternalEvaluationEnforcementSettingMissingTokenAction

外部評価を必要とし、トークンが不足している適用ポリシーを評価する場合の処理。 使用可能な値は Audit と Deny であり、言語式がサポートされています。

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

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

パラメーター セット

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

-ExternalEvaluationEnforcementSettingResultLifespan

エンドポイント呼び出しの結果の有効期間。その後、有効ではなくなります。

値は ISO 8601 期間形式に従う必要があり、言語式がサポートされています。

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

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

パラメーター セット

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

-ExternalEvaluationEnforcementSettingRoleDefinitionId

エンドポイントを呼び出すために割り当ての MSI が必要とするロール定義 ID の配列。

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

型:

String[]

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

パラメーター セット

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

-Id

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

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

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

パラメーター セット

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

-InputObject

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

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

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

パラメーター セット

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

-ManagementGroupName

管理グループの ID。

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

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

パラメーター セット

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

-Metadata

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

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

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

パラメーター セット

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

-Mode

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

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

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

パラメーター セット

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

-Name

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

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

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

パラメーター セット

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

-Parameter

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

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

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

パラメーター セット

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

-Policy

ポリシー ルール。

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

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

パラメーター セット

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

-SubscriptionId

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

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

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

パラメーター セット

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

-Version

#.#.# 形式のポリシー定義のバージョン。

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

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

パラメーター セット

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

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

パラメーター セット

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

CommonParameters

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

入力

IPolicyDefinition

String

String

出力

IPolicyDefinition

メモ

別名

Set-AzPolicyDefinition