Update-AzPolicySetDefinition

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

構文

Name (既定)

Update-AzPolicySetDefinition
    -Name <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-PolicyDefinition <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Version <String>]
    [-PolicyDefinitionGroup <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ManagementGroupName

Update-AzPolicySetDefinition
    -Name <String>
    -ManagementGroupName <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-PolicyDefinition <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Version <String>]
    [-PolicyDefinitionGroup <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SubscriptionId

Update-AzPolicySetDefinition
    -Name <String>
    -SubscriptionId <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-PolicyDefinition <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-Version <String>]
    [-PolicyDefinitionGroup <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Id

Update-AzPolicySetDefinition
    -Id <String>
    [-DisplayName <String>]
    [-Description <String>]
    [-PolicyDefinition <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-PolicyDefinitionGroup <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Update-AzPolicySetDefinition
    -InputObject <IPolicySetDefinition>
    [-DisplayName <String>]
    [-Description <String>]
    [-PolicyDefinition <String>]
    [-Metadata <String>]
    [-Parameter <String>]
    [-PolicyDefinitionGroup <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

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

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

$PolicySetDefinition = Get-AzPolicySetDefinition -Id '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.Id -Description 'Updated policy to not allow virtual machine creation'

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

例 2: ポリシー・セット定義のメタデータを更新する

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

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

例 3: ポリシー・セット定義のグループを更新する

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

このコマンドは、VMPolicySetDefinition という名前のポリシー セット定義のグループを更新します。

例 4: ハッシュ テーブルを使用してポリシー セット定義のグループを更新する

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

このコマンドは、VMPolicySetDefinition という名前のポリシー セット定義のグループをハッシュ テーブルから更新します。

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

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -PolicyDefinition C:\VMPolicySet.json -Version '1.1.0'

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

パラメーター

-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

-Id

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

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

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

パラメーター セット

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

-InputObject

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

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

型:IPolicySetDefinition
規定値: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

-Name

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

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

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

パラメーター セット

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

-Parameter

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

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

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

パラメーター セット

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

-PolicyDefinition

JSON 文字列形式のポリシー セット定義配列。

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

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

パラメーター セット

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

-PolicyDefinitionGroup

ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 構築するには、POLICYDEFINITIONGROUP プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

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

パラメーター セット

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

-SubscriptionId

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

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

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

パラメーター セット

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

-Version

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

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

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

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ManagementGroupName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
SubscriptionId
配置: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を参照してください。

入力

IPolicySetDefinition

String

出力

IPolicySetDefinition

メモ

別名

Set-AzPolicySetDefinition