Update-AzPolicySetDefinition
この操作により、指定されたサブスクリプションまたは管理グループ内の既存のポリシー セット定義が、指定された名前で更新されます。
構文
Update-AzPolicySetDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-PolicyDefinition <String>]
[-Metadata <String>]
[-Parameter <String>]
[-PolicyDefinitionGroup <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzPolicySetDefinition
-Name <String>
-ManagementGroupName <String>
[-DisplayName <String>]
[-Description <String>]
[-PolicyDefinition <String>]
[-Metadata <String>]
[-Parameter <String>]
[-PolicyDefinitionGroup <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzPolicySetDefinition
-Name <String>
-SubscriptionId <String>
[-DisplayName <String>]
[-Description <String>]
[-PolicyDefinition <String>]
[-Metadata <String>]
[-Parameter <String>]
[-PolicyDefinitionGroup <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzPolicySetDefinition
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-PolicyDefinition <String>]
[-Metadata <String>]
[-Parameter <String>]
[-PolicyDefinitionGroup <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzPolicySetDefinition
[-DisplayName <String>]
[-Description <String>]
[-PolicyDefinition <String>]
[-Metadata <String>]
[-Parameter <String>]
[-PolicyDefinitionGroup <String>]
[-BackwardCompatible]
-InputObject <IPolicySetDefinition>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
この操作により、指定されたサブスクリプションまたは管理グループ内の既存のポリシー セット定義が、指定された名前で更新されます。
例
例 1: ポリシー・セット定義の説明を更新する
$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'最初のコマンドは、Get-AzPolicySetDefinition コマンドレットを使用してポリシー セット定義を取得します。 このコマンドは、そのオブジェクトを $PolicySetDefinition 変数に格納します。 2 番目のコマンドは、$PolicySetDefinitionの ResourceId プロパティによって識別されるポリシー セット定義の説明を更新します。
例 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: [Backcompat] ポリシー セット定義のメタデータを更新する
Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'このコマンドは、VMPolicySetDefinition という名前のポリシー セット定義のメタデータを更新して、そのカテゴリが "仮想マシン" であることを示します。
パラメーター
-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
| 型: | IPolicySetDefinition |
| 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 |
-Name
更新するポリシー セット定義の名前。
| 型: | String |
| Aliases: | PolicySetDefinitionName |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Parameter
ポリシー セットで使用されるパラメーターのパラメーター定義。 キーはパラメーター名です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PolicyDefinition
JSON 文字列形式のポリシー定義配列。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PolicyDefinitionGroup
ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 構築するには、POLICYDEFINITIONGROUP プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。
| 型: | String |
| Aliases: | GroupDefinition |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| 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 |
入力
出力
メモ
別名
Set-AzPolicySetDefinition
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示