Set-AzPolicyAssignment

モジュール:

Az.Resources Module

ポリシーの割り当てを変更します。

構文

NameParameterSet (既定)

Set-AzPolicyAssignment
    -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>]

IdParameterSet

Set-AzPolicyAssignment
    -Id <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-AzPolicyAssignment コマンドレットは、ポリシーの割り当てを変更します。 ID または名前とスコープで割り当てを指定します。

例

例 1: 表示名を更新する

PS C:\> $ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
PS C:\> $PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId
PS C:\> Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName 'Do not allow VM creation'

最初のコマンドは、Get-AzResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。 このコマンドは、そのオブジェクトを $ResourceGroup 変数に格納します。 2 番目のコマンドは、Get-AzPolicyAssignment コマンドレットを使用して PolicyAssignment という名前のポリシー割り当てを取得します。 このコマンドは、そのオブジェクトを $PolicyAssignment 変数に格納します。 最後のコマンドは、$ResourceGroupの ResourceId プロパティによって識別されるリソース グループのポリシー割り当ての表示名を更新します。

例 2: ポリシー割り当てにマネージド ID を追加する

PS C:\> $PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment'
PS C:\> Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -AssignIdentity -Location 'westus'

最初のコマンドは、Get-AzPolicyAssignment コマンドレットを使用して、現在のサブスクリプションから PolicyAssignment という名前のポリシー割り当てを取得します。 このコマンドは、そのオブジェクトを $PolicyAssignment 変数に格納します。 最後のコマンドは、ポリシー割り当てにマネージド ID を割り当てます。

パラメーター

-ApiVersion

使用するリソース プロバイダー API のバージョンを指定します。 バージョンを指定しない場合、このコマンドレットは使用可能な最新バージョンを使用します。

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

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

パラメーター セット

(All)

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

-AssignIdentity

このポリシー割り当ての Microsoft Entra ID を生成して割り当てます。 この ID は、'deployIfNotExists' ポリシーのデプロイを実行するときに使用されます。 ID を割り当てるときは、場所が必要です。

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

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

パラメーター セット

(All)

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

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

型:	IAzureContextContainer
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	AzContext, 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
エイリアス:	リソースID

パラメーター セット

IdParameterSet

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

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。 このパラメーターに使用できる値は次のとおりです。

• 続ける
• 不問に付す
• 問い合わせる
• 静かに続行
• 止まれ
• [中断]

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

型:	ActionPreference
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	infa

パラメーター セット

(All)

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

-InformationVariable

情報変数を指定します。

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

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	iv

パラメーター セット

(All)

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

-Location

ポリシー割り当てのリソース ID の場所。 これは、-AssignIdentity スイッチを使用する場合に必要です。

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

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

パラメーター セット

(All)

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

-Metadata

ポリシー割り当ての更新されたメタデータ。 これは、メタデータを含むファイル名へのパス、または文字列としてのメタデータのいずれかです。

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

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

パラメーター セット

(All)

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

-Name

このコマンドレットが変更するポリシー割り当ての名前を指定します。

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

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

パラメーター セット

NameParameterSet

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

-NotScope

ポリシーの割り当てはスコープではありません。

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

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

パラメーター セット

(All)

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

-Pre

このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。

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

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

パラメーター セット

(All)

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

-Scope

ポリシーが適用されるスコープを指定します。

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

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

パラメーター セット

NameParameterSet

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

-Sku

SKU のプロパティを表すハッシュ テーブル。

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

型:	Hashtable
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	SkuObject

パラメーター セット

(All)

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

CommonParameters

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

関連リンク

• Get-AzPolicyAssignment
• New-AzPolicyAssignment
• Remove-AzPolicyAssignment