Update-AzTag

  • リファレンス
モジュール:
Az.Resources

リソースまたはサブスクリプションのタグのセットを選択的に更新します。

構文

Update-AzTag
      [-ResourceId] <String>
      [-Tag] <Hashtable>
      [-Operation] <TagPatchOperation>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

ResourceId を持つ Update-AzTag コマンドレットは、リソースまたはサブスクリプションのタグのセットを選択的に更新します。 この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、タグの値を既存の名前で更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。

例

例 1: "マージ" 操作を使用してサブスクリプションのタグのセットを選択的に更新する

$mergedTags = @{"key1"="value1"; "key3"="value3";}
Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $mergedTags -Operation Merge

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             key1     value1
             key2     value2
             key3     value3

このコマンドは、サブスクリプションのタグのセットを "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" とマージします。

例 2: サブスクリプションのタグのセットを "置換" 操作で選択的に更新する

$replacedTags = @{"key1"="value1"; "key3"="value3";}
Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $replacedTags -Operation Replace

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             key1     value1
             key3     value3

このコマンドは、サブスクリプションのタグのセットを "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" に置き換えます。

例 3: "削除" 操作を使用してサブスクリプションのタグのセットを選択的に更新する

$deletedTags = @{"key1"="value1"}
Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $deletedTags -Operation Delete

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             key3     value3

このコマンドは、サブスクリプションのタグのセットを "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxx" で削除します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

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

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

-Operation

更新操作。 オプションは、マージ、置換、および削除です。

Type:TagPatchOperation
Accepted values:Merge, Replace, Delete
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

タグ付けされたエンティティのリソース識別子。 リソース、リソース グループ、またはサブスクリプションにタグを付ける場合があります。

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

-Tag

更新に使用するタグのセット。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

String

TagPatchOperation

Hashtable

出力

PSTagResource