タグ・キー定義の作成と管理

タグ・キー定義の作成

タグ・ネームスペース内にタグ・キー定義を作成します。タグ・ネームスペースには、最大100個のタグ・キー定義を含めることができます。

「コンピュートWeb UI」の使用

ナビゲーション・メニューで、「ガバナンス」をクリックし、「タグ・ネームスペース」をクリックします。
タグ・キー定義を追加するタグ・ネームスペースがリストされていない場合、タグ・ネームスペース・リストの上にあるコンパートメント・ドロップ・ダウン・メニューを使用して、正しいコンパートメントを選択します。
タグ・キー定義を追加するタグ・ネームスペースの名前をクリックします。
タグ・ネームスペースの詳細ページのリソース・ボックスで、タグ・キー定義をクリックします。
タグ・キー定義領域で、タグ・キー定義の作成ボタンをクリックします。
タグ・キー定義の作成ウィンドウで、次の情報を入力します:
- 名前: キー名。タグ・キー名には次の特性があります:
  - 名前空間内で一意である必要があります。
    
    同じタグ・キー名は、異なるタグ・ネームスペースで使用できます。
  - 大文字と小文字は区別されません。
  - 後で変更できません。
  - 100文字以下にしてください。
  - ピリオド(.)または空白文字を含めることはできません。
- 摘要: タグ・キー定義の説明。この説明は256文字以下にしてください。
タグ値のタイプを選択します。
- 静的値: 移入されていません。ユーザーは、タグがリソースに適用されるときに値を入力する必要があります。これはデフォルト選択です。
- 値リスト: 事前定義済の値リスト。少なくとも1つの値を入力してくださいユーザーは、リソースに適用するこれらの事前定義値のいずれかを選択する必要があります。
  
  複数の値は改行で区切ります重複した値と空白行が無効です。値は大/小文字が区別され、256文字以下にする必要があります。
  
  値には、次のいずれかの変数を含めることができます:
  
  ${iam.principal.name}
  
  リソースにタグ付けしたユーザーの名前。
  
  ${iam.principal.type}
  
  リソースにタグ付けされたプリンシパルのタイプ。次のいずれか: rootユーザー、IAMユーザーまたはインスタンス・プリンシパル。
  
  ${oci.datetime}
  
  タグが作成された日時。
タグ・キー定義の作成をクリックします。

新しいタグ・キー定義の詳細ページが表示されます。

OCI CLIの使用

タグ・ネームスペースOCIDを取得します。

$ oci iam tag-namespace list --compartment-id compartment_OCID

タグ・キー定義createコマンドを実行します。

次のコマンドは、タグがリソースに適用されるときにユーザーがタグ値を入力する必要があるタグ・キー定義を作成します。 --validatorオプションを省略することは、「コンピュートWeb UI」で「静的値」値タイプを選択することと同等です。

構文:
```
oci iam tag create --tag-namespace-id tag_namespace_OCID --name text --description "text"
```
例:
```
$ oci iam tag create --tag-namespace-id ocid1.tagnamespace.unique_ID --name VolumeType \
--description "Identify volumes by type"
```
次のコマンドは、タグの適用時にユーザーが選択する必要がある値のリストを含むタグ・キー定義を作成します。

構文:
```
oci iam tag create --tag-namespace-id tag_namespace_OCID --name text --description "text" \
--validator values
```
--validatorオプション引数の値は、タグ値のJSON定義です。このJSON定義は、コマンドラインまたはファイルで文字列として指定できます。

リソースへのタグ付けに使用するベース・コマンドとともに--generate-param-json-inputオプションを使用して、指定する正しいJSONのテンプレートを生成できます。 --generate-param-json-inputオプションの引数は、次の例に示すように、オプション・インジケータ(--)なしでタグ値(--validator)を指定するために使用するオプションの名前です:
```
$ oci iam tag create --generate-param-json-input validator > volume_types.json
```
出力volume_types.jsonファイルの内容は次のとおりです:
```
{
  "validatorType": "ENUM",
  "values": [
    "string",
    "string"
  ]
}
```
このテンプレートを編集して、新しいタグ値を指定します。 valuesの値は、単一の文字列または文字列の配列です。 validator-typeはENUMである必要があります。最終コマンドの--validatorオプションに結果を指定します。

次の例では、タグ値がインラインJSON文字列で指定されています。
```
$ oci iam tag create --tag-namespace-id ocid1.tagnamespace.unique_ID --name VolumeType \
--description "Identify volumes by type" \
--validator '{"validator-type": "ENUM", "values": ["typeA","typeB","typeC"]}'
```
次の例では、変数値が含まれています:
```
$ oci iam tag create --tag-namespace-id ocid1.tagnamespace.unique_ID --name Product-XYZ \
--description "Identify resources assigned to XYZ development." \
--validator '{"validator-type": "ENUM", "values": ["Assigned by: ${iam.principal.name}"]}'
```
次の例では、タグ値がJSONファイルに指定されています。 file://構文を使用して、ファイルをオプション引数として指定します。
```
$ oci iam tag create  --tag-namespace-id ocid1.tagnamespace.unique_ID --name VolumeType \
--validator file://volume_types.json
```
このコマンドは、tag getコマンドと同じ出力を返します。

タグ・キー定義の更新

タグ・キー定義の説明を更新し、タグ値のタイプと値を変更できます。廃止されているタグ・キー定義は更新できません。

更新するタグ・キー定義の値が事前定義済リストである場合、タグのデフォルトの値である値を削除または変更することはできません。タグのデフォルトの値であるタグ・キー定義値を削除または変更するには、まず、異なる値を使用するようにタグのデフォルトを更新します。「タグのデフォルトの構成」を参照してください。

「コンピュートWeb UI」の使用

ナビゲーション・メニューで、「ガバナンス」をクリックし、「タグ・ネームスペース」をクリックします。
タグ・キー定義を更新するタグ・ネームスペースがリストされていない場合、タグ・ネームスペース・リストの上にあるコンパートメント・ドロップ・ダウン・メニューを使用して、正しいコンパートメントを選択します。
タグ・キー定義を更新するタグ・ネームスペースの名前をクリックします。
タグ・ネームスペースの詳細ページのリソース・ボックスで、タグ・キー定義をクリックします。
更新するタグ・キー定義について、アクション・メニューをクリックし、編集オプションをクリックします。
「タグ・キー定義の編集」ダイアログで、説明を変更したり、タグ値タイプを変更できます。タイプに値リストを選択した場合は、値ボックスに少なくとも1つの値を追加する必要があります。複数の値は改行で区切ります重複した値と空白行が無効です。値は大/小文字が区別され、256文字以下にする必要があります。
「変更の保存」をクリックします。

OCI CLIの使用

次の情報を取得します:

タグ・ネームスペースOCID。

$ oci iam tag-namespace list --compartment-id compartment_OCID

タグ・キーの名前。

$ oci iam tag list --tag-namespace-id tag_namespace_OCID

タグ・キー定義更新コマンドを実行します。

次のコマンドは、タグ・キーの説明のみを更新します。値設定は同じままです。

構文:
```
oci iam tag update --tag-namespace-id tag_namespace_OCID --tag-name text --description "text"
```
例:
```
$ oci iam tag update --tag-namespace-id ocid1.tagnamespace.unique_ID --tag-name VolumeType \
--description "Identify the type of the volume."
```
次のコマンドは、値のみを更新します。
```
$ oci iam tag update --tag-namespace-id ocid1.tagnamespace.unique_ID --tag-name VolumeType \
--validator file://volume_types.json
WARNING: Updates to freeform-tags and defined-tags and validator will replace any existing 
values.
Are you sure you want to continue? [y/N]: y
```
volume_types.jsonファイルの内容については、「タグ・キー定義の作成」を参照してください。 --validatorオプションに指定した値は、既存の値を置き換えます。値を追加したり、値の一部のみを変更するには、この更新の完全なリストを指定します。

次のコマンドは、値タイプを更新して、事前定義済の値リストから選択するのではなく値を入力できるようにします。
```
$ oci iam tag update --tag-namespace-id ocid1.tagnamespace.unique_ID --tag-name VolumeType \
--validator '{}'
```
このコマンドは、tag getコマンドと同じ出力を返します。

タグ・キー定義の廃止

タグ・キー定義をリタイアすると、このタグ・キー定義に基づくタグはリソースに適用できません。このタグ・キー定義に基づく既存のタグのデフォルトは、新しく作成されたリソースに自動的に適用されません。ただし、タグはすでに適用されているリソースからは削除されません。タグは、これらのリソースのメタデータとして存在し、リスト、ソートおよびレポートなどの操作で廃止されたタグを使用できます。

「コンピュートWeb UI」の使用

ナビゲーション・メニューで、「ガバナンス」をクリックし、「タグ・ネームスペース」をクリックします。
タグ・キー定義を廃止するタグ・ネームスペースがリストされていない場合は、タグ・ネームスペース・リストの上にあるコンパートメント・ドロップ・ダウン・メニューを使用して、正しいコンパートメントを選択します。
タグ・キー定義をリタイアするタグ・ネームスペースの名前をクリックします。
タグ・ネームスペースの詳細ページのリソース・ボックスで、タグ・キー定義をクリックします。
廃止するタグ・キー定義について、アクション・メニューをクリックし、廃止オプションをクリックします。
Retire Tag Key Definition確認プロンプトで、Confirmをクリックします。

OCI CLIの使用

次の情報を取得します:

タグ・ネームスペースOCID。

$ oci iam tag-namespace list --compartment-id compartment_OCID

タグ・キーの名前。

$ oci iam tag list --tag-namespace-id tag_namespace_OCID

タグ・キー定義retireコマンドを実行します。

構文:

oci iam tag retire --tag-name text --tag-namespace-id tag_namespace_OCID

タグ・キー定義の再アクティブ化

タグ・キー定義を再アクティブ化すると、再度リソースに適用できるようになります。親タグ・ネームスペースが廃止されている場合、タグ・キー定義を再アクティブ化することはできません。

「コンピュートWeb UI」の使用

ナビゲーション・メニューで、「ガバナンス」をクリックし、「タグ・ネームスペース」をクリックします。
タグ・キー定義を再アクティブ化するタグ・ネームスペースがリストされていない場合、タグ・ネームスペース・リストの上にあるコンパートメント・ドロップ・ダウン・メニューを使用して、正しいコンパートメントを選択します。
タグ・キー定義を再アクティブ化するタグ・ネームスペースの名前をクリックします。
タグ・ネームスペースの詳細ページのリソース・ボックスで、タグ・キー定義をクリックします。
再アクティブ化するタグ・キー定義について、アクション・メニューをクリックし、再アクティブ化オプションをクリックします。
タグ・ネームスペースの再アクティブ化確認プロンプトで、確認をクリックします。

OCI CLIの使用

次の情報を取得します:

タグ・ネームスペースOCID。

$ oci iam tag-namespace list --compartment-id compartment_OCID

タグ・キーの名前。

$ oci iam tag list --tag-namespace-id tag_namespace_OCID

タグ・キー定義reactivateコマンドを実行します。

構文:

oci iam tag reactivate --tag-name text --tag-namespace-id tag_namespace_OCID

タグ・キー定義の削除

タグ・キー定義は、削除する前に廃止する必要があります。「タグ・キー定義の廃止」を参照してください。

タグ・キー定義を削除すると、このタグ・キー定義に基づくタグがすべてのリソースから削除されます。このタグ・キー定義に基づくタグのデフォルトは、コンパートメントから削除されません。

「コンピュートWeb UI」の使用

ナビゲーション・メニューで、「ガバナンス」をクリックし、「タグ・ネームスペース」をクリックします。
タグ・キー定義を削除するタグ・ネームスペースがリストされていない場合は、タグ・ネームスペース・リストの上にあるコンパートメント・ドロップ・ダウン・メニューを使用して、正しいコンパートメントを選択します。
タグ・キー定義を削除するタグ・ネームスペースの名前をクリックします。
タグ・ネームスペースの詳細ページのリソース・ボックスで、タグ・キー定義をクリックします。
削除するタグ・キー定義が廃止されていることを確認します(状態が無効です)。
削除するタグ・キー定義について、アクション・メニューをクリックし、削除オプションをクリックします。

削除されたタグ・キー定義はリストアできません。
Delete Tag Key Definitionプロンプトで、Confirmをクリックします。

タグ・キー定義ステータスが削除中に変わり、このタグ・キー定義に基づくすべてのタグがリソースから削除されます。

タグの削除プロセスが完了すると、タグ・キー定義ステータスが削除済に変わります。削除されたタグ・キー定義と同じ名前で、新しいタグ・キー定義を作成できます。

OCI CLIの使用

次の情報を取得します:

タグ・ネームスペースOCID。

$ oci iam tag-namespace list --compartment-id compartment_OCID

タグ・キーの名前。

$ oci iam tag list --tag-namespace-id tag_namespace_OCID

削除するタグ・キー定義が廃止されていることを確認します(状態が無効です)。
```
$ oci iam tag get --tag-namespace-id tag_namespace_OCID
```

タグ・キー定義削除コマンドを実行します。

構文:

oci iam tag delete --tag-name text --tag-namespace-id tag_namespace_OCID

例:

$ oci iam tag delete --tag-name volume-types --tag-namespace-id ocid1.tagnamespace.unique_ID
Are you sure you want to delete this resource? [y/N]: y
{
  "opc-work-request-id": "ocid1.workrequest.unique_ID"
}

タグの削除のステータスを確認するには、次のコマンドを使用します:

$ oci iam tagging-work-request get --work-request-id ocid1.workrequest.unique_ID

確認せずにタグ・キー定義を削除するには、--forceオプションを使用します。