Remove-AzTag

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

定義済みの Azure タグまたは値を削除する |リソースまたはサブスクリプションのタグのセット全体を削除します。

構文

Remove-AzTag
      [-Name] <String>
      [[-Value] <String[]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzTag
      [-PassThru]
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

RemovePredefinedTagSet: Remove-AzTag コマンドレットは、定義済みの Azure タグと値をサブスクリプションから削除します。 定義済みのタグから特定の値を削除するには、Value パラメーターを使用します。 既定では、 Remove-AzTag は指定されたタグとそのすべての値を削除します。リソースまたはリソース グループに現在適用されているタグまたは値を削除することはできません。 Remove-AzTag を使用する前に、Set-AzResourceGroup コマンドレットの Tag パラメーターを使用して、リソースまたはリソース グループからタグまたは値を削除します。 Remove-AzTag が含まれる Azure Tags モジュールは、定義済みの Azure タグを管理するのに役立ちます。 Azure タグは、部門やコスト センターなど、Azure リソースとリソース グループを分類したり、リソースやグループに関するメモやコメントを追跡したりするために使用できる名前と値のペアです。 タグは 1 つの手順で定義して適用できますが、定義済みのタグを使用すると、サブスクリプション内のタグの標準的で一貫性のある予測可能な名前と値を確立できます。

RemoveByResourceIdParameterSet: ResourceId を持つ Remove-AzTag コマンドレットは、リソースまたはサブスクリプションのタグのセット全体を削除します。

例

例 1: 定義済みのタグを削除する

Remove-AzTag -Name "Department"

このコマンドは、Department という名前の定義済みのタグとそのすべての値を削除します。 タグがリソースまたはリソース グループに適用されている場合、コマンドは失敗します。

例 2: 定義済みのタグから値を削除する

Remove-AzTag -Name "Department" -Value "HumanResources" -PassThru

Name:   Department
Count:  14
Values: 

        Name        Count
        =========   =====

        Finance        2
        IT            12

このコマンドは、定義済みの Department タグから HumanResources 値を削除します。 タグは削除されません。 値がリソースまたはリソース グループに適用されている場合、コマンドは失敗します。

例 3: サブスクリプションのタグのセット全体を削除する

Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

このコマンドは、{subId} を使用してサブスクリプションのタグのセット全体を削除します。 "-PassThru" を渡さないと、削除されたオブジェクトは返されません。

例 4: リソースのタグのセット全体を削除する

Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -PassThru

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             Dept     Finance
             Status   Normal

このコマンドは、{resourceId} を使用してリソースのタグのセット全体を削除します。 "-PassThru" を渡すと、削除された oject が返されます。

パラメーター

-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

-Name

削除する定義済みタグの名前を指定します。 既定では、 Remove-AzTag は指定されたタグとそのすべての値を削除します。 選択した値を削除し、タグを削除しない場合は、Value パラメーターを使用します。

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

-PassThru

削除されたタグ、または削除された値を持つ結果のタグを表すオブジェクトを返します。

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

-ResourceId

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

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

-Value

定義済みのタグから指定した値を削除しますが、タグは削除しません。

Type:String[]
Position:1
Default value:None
Required:False
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

String[]

SwitchParameter

出力

Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource