New-AzTag

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

定義済みの Azure タグを作成するか、既存のタグに値を追加する |リソースまたはサブスクリプションのタグのセット全体を作成または更新します。

構文

New-AzTag
   [-Name] <String>
   [[-Value] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzTag
   [-ResourceId] <String>
   [-Tag] <Hashtable>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

CreatePredefinedTagSet: New-AzTag コマンドレットは、省略可能な定義済みの値を持つ定義済みの Azure タグを作成します。 また、これを使用して、既存の定義済みタグに値を追加することもできます。 定義済みのタグを作成するには、一意のタグ名を入力します。 既存の定義済みタグに値を追加するには、既存のタグの名前と新しい値を指定します。 このコマンドレットは、新しいタグまたは変更されたタグとその値と、それが適用されたリソースの数を表すオブジェクトを返します。 New-AzTag が含まれる Azure Tags モジュールは、定義済みの Azure タグを管理するのに役立ちます。 Azure タグは、部門やコスト センターなど、Azure リソースとリソース グループを分類したり、リソースやグループに関するメモやコメントを追跡したりするために使用できる名前と値のペアです。 タグは 1 つの手順で定義して適用できますが、定義済みのタグを使用すると、サブスクリプション内のタグの標準的で一貫性のある予測可能な名前と値を確立できます。 定義済みのタグをリソースまたはリソース グループに適用するには、New-AzTag コマンドレットの Tag パラメーターを使用します。 指定したタグ名または名前と値を持つリソース グループを検索するには、Get-AzResourceGroup コマンドレットの Tag パラメーターを使用します。 すべてのタグには名前があります。 値は省略可能です。 定義済みの Azure タグには複数の値を指定できますが、リソースまたはリソース グループにタグを適用する場合は、タグ名とその値の 1 つだけを適用します。 たとえば、財務、人事、IT など、各部門の値を含む定義済みの Department タグを作成できます。 リソースに Department タグを適用する場合は、Finance などの定義済みの値を 1 つだけ適用します。

CreateByResourceIdParameterSet: ResourceId を持つ New-AzTag コマンドレットは、リソースまたはサブスクリプションのタグのセット全体を作成または更新します。 この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。

例

例 1: 定義済みのタグを作成する

New-AzTag -Name "FY2015"

Name   ValuesTable Count Values 
----   ----------- ----- ------
FY2015             0     {}

このコマンドは、FY2015 という名前の定義済みタグを作成します。 このタグには値がありません。 値のないタグをリソースまたはリソース グループに適用することも、New-AzTag を使用してタグに値を追加することもできます。 タグをリソースまたはリソース グループに適用するときに値を指定することもできます。

例 2: 値を含む定義済みのタグを作成する

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values: 

        Name        Count
        =========   =====
        Finance     0

このコマンドは、値が Finance の Department という名前の定義済みタグを作成します。

例 3: 定義済みのタグに値を追加する

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values: 
        Name        Count
        =========   =====
        Finance     0 
New-AzTag -Name "Department" -Value "IT"
Name:   Department
Count:  0
Values: 
        Name        Count
        =========   =====
        Finance     0
        IT          0

これらのコマンドは、Department という名前の定義済みのタグを 2 つの値で作成します。 タグ名が存在する場合、 New-AzTag は新しいタグを作成するのではなく、既存のタグに値を追加します。

例 4: 定義済みのタグを使用する

New-AzTag -Name "CostCenter" -Value "0001"

Name:   CostCenter
Count:  0
Values: 
        Name        Count
        =========   =====
        0001        0 

Set-AzResourceGroup -Name "EngineerBlog" -Tag @{Name="CostCenter";Value="0001"}

Name:      EngineerBlog
Location:  East US
Resources: 
            
  Name             Type                     Location
    ===============  =======================  ========
    EngineerBlog     Microsoft.Web/sites      West US
    EngSvr01         Microsoft.Sql/servers    West US
    EngDB02          Microsoft.Sql/databases  West US
Tags: 
    Name         Value
    ==========   =====
    CostCenter   0001 

Get-AzTag -Name "CostCenter"

Name:   CostCenter
Count:  1
Values: 
        Name        Count
        =========   =====
        0001        1 

Get-AzResourceGroup -Tag @{Name="CostCenter"}

Name:      EngineerBlog
Location:  East US
Resources: 
     Name             Type                     Location
    ===============  =======================  ========
    EngineerBlog     Microsoft.Web/sites      West US

    EngSvr01         Microsoft.Sql/servers    West US
    EngDB02          Microsoft.Sql/databases  West US
Tags: 
    Name         Value
    ==========   =====
    CostCenter   0001

この例のコマンドは、定義済みのタグを作成して使用します。

例 5: サブスクリプションのタグのセット全体を作成または更新する

$Tags = @{"tagKey1"="tagValue1"; "tagKey2"="tagValue2"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $Tags

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             tagKey1  tagValue1
             tagKey2  tagValue2

このコマンドは、{subId} を使用して、サブスクリプションのタグのセット全体を作成または更新します。

例 6: リソースのタグのセット全体を作成または更新する

$Tags = @{"Dept"="Finance"; "Status"="Normal"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -Tag $Tags

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

このコマンドは、{resourceId} を使用してリソースのタグのセット全体を作成または更新します。

パラメーター

-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

定義済みのタグ名を指定します。 新しい定義済みタグを作成するには、一意の名前を入力します。 既存のタグに値を追加するには、既存のタグの名前を入力します。 既存の定義済みタグの名前が指定されている場合、 New-AzTag は、新しいタグを作成する代わりに、指定した値 (存在する場合) をその名前のタグに追加します。

Type:String
Position:0
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

-Value

定義済みのタグ値を指定します。 定義済みのタグには複数の値を指定できますが、各コマンドに入力できる値は 1 つだけです。 タグには値のない名前を付けることができるため、このパラメーターは省略可能です。

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

Hashtable

出力

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