Set-AzureRmPolicyAssignment
ポリシーの割り当てを変更します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmPolicyAssignment
-Name <String>
-Scope <String>
[-NotScope <String[]>]
[-DisplayName <String>]
[-Description <String>]
[-Metadata <String>]
[-Sku <Hashtable>]
[-AssignIdentity]
[-Location <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureRmPolicyAssignment
[-NotScope <String[]>]
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-Metadata <String>]
[-Sku <Hashtable>]
[-AssignIdentity]
[-Location <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] 説明
Set-AzureRmPolicyAssignment コマンドレットは、ポリシーの割り当てを変更します。 ID または名前とスコープで割り当てを指定します。
例
例 1: 表示名を更新する
PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11'
PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId
PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName 'Do not allow VM creation'最初のコマンドは、Get-AzureRMResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。 このコマンドは、そのオブジェクトを $ResourceGroup 変数に格納します。 2 番目のコマンドは、Get-AzureRmPolicyAssignment コマンドレットを使用して PolicyAssignment という名前のポリシー割り当てを取得します。 このコマンドは、そのオブジェクトを $PolicyAssignment 変数に格納します。 最後のコマンドは、$ResourceGroupの ResourceId プロパティによって識別されるリソース グループのポリシー割り当ての表示名を更新します。
例 2: ポリシー割り当てにマネージド ID を追加する
PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment'
PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -AssignIdentity -Location 'westus'最初のコマンドは、Get-AzureRmPolicyAssignment コマンドレットを使用して、現在のサブスクリプションから PolicyAssignment という名前のポリシー割り当てを取得します。 このコマンドは、そのオブジェクトを $PolicyAssignment 変数に格納します。 最後のコマンドは、ポリシー割り当てにマネージド ID を割り当てます。
パラメーター
-ApiVersion
使用するリソース プロバイダー API のバージョンを指定します。 バージョンを指定しない場合、このコマンドレットは使用可能な最新バージョンを使用します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-AssignIdentity
このポリシー割り当ての Microsoft Entra ID を生成して割り当てます。 ID は、'deployIfNotExists' ポリシーのデプロイを実行するときに使用されます。 ID を割り当てるときに場所が必要です。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Description
ポリシー割り当ての説明
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DisplayName
ポリシー割り当ての新しい表示名を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Id
このコマンドレットが変更するポリシー割り当ての完全修飾リソース ID を指定します。
| 型: | String |
| Aliases: | ResourceId |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。 このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- 停止
- Suspend
| 型: | ActionPreference |
| Aliases: | infa |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationVariable
情報変数を指定します。
| 型: | String |
| Aliases: | iv |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Location
ポリシー割り当てのリソース ID の場所。 これは、-AssignIdentity スイッチを使用する場合に必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Metadata
ポリシー割り当ての更新されたメタデータ。 これは、メタデータを含むファイル名へのパスか、メタデータを文字列として指定できます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットが変更するポリシー割り当ての名前を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-NotScope
ポリシーの割り当てはスコープではありません。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Scope
ポリシーを適用するスコープを指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Sku
SKU のプロパティを表すハッシュ テーブル。
| 型: | Hashtable |
| Aliases: | SkuObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |