Set-AzureRmResourceGroup

リファレンス

モジュール:: AzureRM.Resources

リソースグループを変更します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmResourceGroup
   [-Name] <String>
   [-Tag] <Hashtable>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Set-AzureRmResourceGroup
   [-Tag] <Hashtable>
   [-Id] <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Set-AzureRmResourceGroup コマンドレットは、リソースグループのプロパティを変更します。このコマンドレットを使用して、リソースグループに適用された Azure タグを追加、変更、または削除できます。リソースグループを 識別する Name パラメーターと、タグを 変更する Tag パラメーターを指定します。このコマンドレットを使用してリソースグループの名前を変更することはできません。

例

例 1: リソースグループにタグを適用する

PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{Department="IT"}

このコマンドは、IT の値を持つ Department タグを、既存のタグがないリソースグループに適用します。

例 2: リソースグループにタグを追加する

PS C:\>$Tags = (Get-AzureRmResourceGroup -Name "ContosoRG").Tags
PS C:\> $Tags
PS C:\> $Tags += @{"Status"="Approved"; "FY2016"=$null}
PS C:\> Set-AzureRmResourceGroup -Name "ContosoRG" -Tag $Tags
PS C:> (Get-AzureRmResourceGroup -Name "ContosoRG").Tags

次の使用例は、既存のタグを持つリソースグループに、値が Approved の Status タグと FY2016 タグを追加します。指定したタグは既存のタグを置き換えるため、既存のタグを新しいタグコレクションに含める必要があります。または、タグが失われます。最初のコマンドは ContosoRG リソースグループを取得し、dot メソッドを使用してその Tags プロパティの値を取得します。このコマンドは、$Tags変数にタグを格納します。 2 番目のコマンドは、$Tags変数のタグを取得します。 3 番目のコマンドでは、+= 代入演算子を使用して、status タグと FY2016 タグを $Tags 変数内のタグの配列に追加します。 4 番目のコマンドでは、Set-AzureRmResourceGroup の Tag パラメーターを使用して、$Tags変数のタグを ContosoRG リソースグループに適用します。 5 番目のコマンドは、ContosoRG リソースグループに適用されているすべてのタグを取得します。出力は、リソースグループに Department タグと 2 つの新しいタグである Status と FY2015 があることを示しています。

例 3: リソースグループのすべてのタグを削除する

PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{}

このコマンドは、 ContosoRG リソースグループからすべてのタグを削除するために、空のハッシュテーブル値を持つ Tag パラメーターを指定します。

パラメーター

-ApiVersion

リソースプロバイダーでサポートされている API バージョンを指定します。既定のバージョンとは異なるバージョンを指定できます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

変更するリソースグループの ID を指定します。

Type:	String
Aliases:	ResourceGroupId, ResourceId
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

変更するリソースグループの名前を指定します。

Type:	String
Aliases:	ResourceGroupName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

ハッシュテーブルの形式のキーと値のペア。例: @{key0="value0";key1=$null;key2="value2"} タグは、リソースとリソースグループに作成して適用できる名前と値のペアです。リソースとグループにタグを割り当てた後、Get-AzureRmResource と Get-AzureRmResourceGroup の Tag パラメーターを使用して、タグ名または名前と値でリソースとグループを検索できます。タグを使用して、部門やコストセンターなどのリソースを分類したり、リソースに関するメモやコメントを追跡したりできます。タグを追加または変更するには、リソースグループのタグのコレクションを置き換える必要があります。タグを削除するには、削除するタグを除き、Get-AzureRmResourceGroup からリソースグループに現在適用されているすべてのタグを含むハッシュテーブルを入力します。リソースグループからすべてのタグを削除するには、空のハッシュテーブルを指定します @{}。

Type:	Hashtable
Aliases:	Tags
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

入力

None

出力

Microsoft.Azure.Commands.Resources.Models.PSResourceGroup

Set-AzureRmResourceGroup

構文

説明

例

例 1: リソース グループにタグを適用する

例 2: リソース グループにタグを追加する

例 3: リソース グループのすべてのタグを削除する