Set-AzureRmResourceGroup
リソース グループを変更します。
警告
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 バージョンを指定します。 既定のバージョンとは異なるバージョンを指定できます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
変更するリソース グループの ID を指定します。
型: | String |
Aliases: | ResourceGroupId, ResourceId |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
変更するリソース グループの名前を指定します。
型: | String |
Aliases: | ResourceGroupName |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"} タグは、リソースとリソース グループに作成して適用できる名前と値のペアです。 リソースとグループにタグを割り当てた後、Get-AzureRmResource と Get-AzureRmResourceGroup の Tag パラメーターを使用して、タグ名または名前と値でリソースとグループを検索できます。 タグを使用して、部門やコスト センターなどのリソースを分類したり、リソースに関するメモやコメントを追跡したりできます。
タグを追加または変更するには、リソース グループのタグのコレクションを置き換える必要があります。 タグを削除するには、削除するタグを除き、Get-AzureRmResourceGroup からリソース グループに現在適用されているすべてのタグを含むハッシュ テーブルを入力します。 リソース グループからすべてのタグを削除するには、空のハッシュ テーブルを指定します @{}
。
型: | Hashtable |
Aliases: | Tags |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
None
出力
Microsoft.Azure.Commands.Resources.Models.PSResourceGroup