az tag

  • リファレンス

リソースのタグ管理。

コマンド

名前 説明 型 Status
az tag add-value

タグ値を作成します。

 コア GA
az tag create

特定のリソースにタグを作成します。

 コア GA
az tag delete

特定のリソースのタグを削除します。

 コア GA
az tag list

特定のリソースのタグのセット全体を一覧表示します。

 コア GA
az tag remove-value

定義済みのタグ名の定義済みタグ値を削除します。

 コア GA
az tag update

特定のリソースのタグのセットを選択的に更新します。

 コア GA

az tag add-value

編集

タグ値を作成します。

az tag add-value --name
                 --value

例

タグ値を作成します。

az tag add-value --name MyTag --value MyValue

必須のパラメーター

--name -n

タグ名。

--value

タグの値。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az tag create

編集

特定のリソースにタグを作成します。

id を持つ az tag create コマンドは、リソース、リソース グループ、またはサブスクリプションのタグのセット全体を作成または更新します。 この操作により、指定したリソース、リソース グループ、またはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。 注意: 'tag create' は 'tag init' のように動作するため、このコマンドで作成されたタグは実行後に存在する唯一のタグです。

az tag create [--name]
              [--resource-id]
              [--tags]

例

サブスクリプションにタグを作成します。

az tag create --name MyTag

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

az tag create --resource-id /subscriptions/{subId} --tags Dept=Finance Status=Normal

リソース グループのタグのセット全体を作成または更新します。

az tag create --resource-id /subscriptions/{sub-id}/resourcegroups/{rg} --tags Dept=Finance Status=Normal

リソースのタグのセット全体を作成または更新します。

az tag create --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}/providers/Microsoft.Compute/virtualMachines/{vmName} --tags Dept=Finance Status=Normal

省略可能のパラメーター

--name -n

作成するタグの名前。

--resource-id

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

--tags

リソースに適用するタグ。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az tag delete

編集

特定のリソースのタグを削除します。

id を持つ az tag delete コマンドは、リソース、リソース グループ、またはサブスクリプションのタグのセット全体を削除します。

az tag delete [--name]
              [--resource-id]
              [--yes]

例

リソースに関連付けられていない、またはタグ値がないサブスクリプションから定義済みのタグを削除します。

az tag delete --name MyTag

サブスクリプションのタグのセット全体を削除します。

az tag delete --resource-id /subscriptions/{sub-id}

リソース グループのタグのセット全体を削除します。

az tag delete --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}

リソースのタグのセット全体を削除します。 (--name と --resource-id を使用して 1 つのタグを指定する場合でも)

az tag delete --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}/providers/Microsoft.Compute/virtualMachines/{vmName}

省略可能のパラメーター

--name -n

削除するタグの名前。

--resource-id

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

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az tag list

編集

特定のリソースのタグのセット全体を一覧表示します。

id を持つ az tag list コマンドは、リソース、リソース グループ、またはサブスクリプション上のタグのセット全体を一覧表示します。

az tag list [--resource-id]

例

サブスクリプションのタグのセット全体を一覧表示します。

az tag list --resource-id /subscriptions/{sub-id}

リソース グループのタグのセット全体を一覧表示します。

az tag list --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}

リソースのタグのセット全体を一覧表示します。

az tag list --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}/providers/Microsoft.Compute/virtualMachines/{vmName}

省略可能のパラメーター

--resource-id

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

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az tag remove-value

編集

定義済みのタグ名の定義済みタグ値を削除します。

この操作により、既存の定義済みタグ名の定義済み値の一覧から値を削除できます。 削除される値は、リソースの特定のタグ名のタグ値として使用することはできません。

az tag remove-value --name
                    --value

必須のパラメーター

--name -n

タグ名。

--value

タグの値。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az tag update

編集

特定のリソースのタグのセットを選択的に更新します。

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

az tag update --operation {Delete, Merge, Replace}
              --resource-id
              --tags

例

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

az tag update --resource-id /subscriptions/{sub-id} --operation merge --tags key1=value1 key3=value3

リソース グループのタグのセットを "置換" 操作で選択的に更新します。

az tag update --resource-id /subscriptions/{sub-id}/resourcegroups/{rg} --operation replace --tags key1=value1 key3=value3

"削除" 操作を使用して、リソースのタグのセットを選択的に更新します。

az tag update --resource-id /subscriptions/{sub-id}/resourcegroups/{rg}/providers/Microsoft.Compute/virtualMachines/{vmName} --operation delete --tags key1=value1

必須のパラメーター

--operation

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

承認された値: Delete, Merge, Replace
--resource-id

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

--tags

リソースで更新するタグ。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。