Get-AzureRmTag

リファレンス

モジュール:: AzureRM.Tags

定義済みの Azure タグを取得します。

警告

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

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

構文

Get-AzureRmTag
   [[-Name] <String>]
   [-Detailed]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzureRmTag コマンドレットは、サブスクリプションで定義済みの Azure タグを取得します。このコマンドレットは、タグに関する基本情報、またはタグとその値に関する詳細情報を返します。すべての出力オブジェクトには、タグと値が適用されたリソースとリソースグループの数を表す Count プロパティが含まれます。 Get-AzureRMTag が含まれる Azure Tags モジュールは、定義済みの Azure タグを管理するのに役立ちます。 Azure タグは、部門やコストセンターなど、Azure リソースとリソースグループを分類したり、リソースやグループに関するメモやコメントを追跡したりするために使用できる名前と値のペアです。タグは 1 つの手順で定義して適用できますが、定義済みのタグを使用すると、サブスクリプション内のタグの標準的で一貫性のある予測可能な名前と値を確立できます。定義済みのタグを作成するには、New-AzureRmTag コマンドレットを使用します。定義済みのタグをリソースグループに適用するには、New-AzureRmTag コマンドレットの Tag パラメーターを使用します。リソースグループで特定のタグ名または名前と値を検索するには、Get-AzureRMResourceGroup コマンドレットの Tag パラメーターを使用します。

例

例 1: 定義済みタグをすべて取得する

PS C:\>Get-AzureRmTag

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

Department    5
FY2015        2
CostCenter   20

このコマンドは、サブスクリプション内のすべての定義済みタグを取得します。 Count プロパティは、サブスクリプション内のリソースとリソースグループにタグが適用された回数を示します。

例 2: 名前でタグを取得する

PS C:\>Get-AzureRmTag -Name "Department"

Name:   Department
Count:  5
Values: 

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

        Finance       2
        IT            3

このコマンドは、Department タグとその値に関する詳細情報を取得します。 Count プロパティは、タグとその各値がサブスクリプション内のリソースとリソースグループに適用された回数を示します。

例 3: すべてのタグの値を取得する

PS C:\>Get-AzureRmTag -Detailed

Name:   Department
Count:  5
Values: 

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

        Finance       2
        IT            3


Name:   FY2015
Count:  2


Name:   CostCenter
Count:  20
Values: 

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

        0001          5
        0002         10
        0003          5

このコマンドでは、Detailed パラメーターを使用して、サブスクリプション内のすべての定義済みタグに関する詳細情報を取得します。 Detailed パラメーターの使用は、すべてのタグに Name パラメーターを使用することと同じです。

パラメーター

-DefaultProfile

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

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

-Detailed

この操作によって、タグ値に関する情報が出力に追加されることを示します。

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

-Name

取得するタグの名前を指定します。既定では、 Get-AzureRmTag はサブスクリプション内のすべての定義済みタグに関する基本情報を取得します。 Name パラメーターを指定しても、Detailed パラメーターは無効になります。

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

入力

String

SwitchParameter

出力

PSTag