[comment]: # aside: 1
[comment]: # ({ee4a2645-28092341})
# User macroオブジェクト
次のオブジェクトは、`usermacro`APIに直接関連しています。
[comment]: # ({/ee4a2645-28092341})
[comment]: # ({2f5f2156-e654cd12})
### グローバルマクロ
グローバルマクロオブジェクトには、以下のプロパティがあります。
|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|globalmacroid|ID|グローバルマクロのID。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- *読み取り専用*
- 更新操作では*必須*|
|macro|string|マクロ文字列。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- 作成操作では*必須*|
|value|string|マクロの値。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- `type` が「Secret macro」に設定されている場合は *書き込み専用*
- 作成操作では*必須*|
|type|integer|マクロのタイプ。
指定可能な値:
0 - *(デフォルト)* Text macro;
1 - Secret macro;
2 - Vault secret.|
|description|string|マクロの説明。|
[comment]: # ({/2f5f2156-e654cd12})
[comment]: # ({c73e8f15-5a3a9f9f})
### ホストマクロ
ホストマクロオブジェクトは、ホスト、ホスト
プロトタイプ、またはテンプレートで利用可能なマクロを定義します。以下のプロパティがあります。
|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|hostmacroid|ID|ホストマクロのID。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- *読み取り専用*
- 更新操作で *必須*|
|hostid|ID|このマクロが属するホストのID。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- *固定*
- 作成操作で *必須*|
|macro|string|マクロ文字列。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- 作成操作で *必須*|
|value|string|マクロの値。
[プロパティの動作](/manual/api/reference_commentary#property-behavior):
- `type` が "Secret macro" に設定されている場合は *書き込み専用*
- 作成操作で *必須*|
|type|integer|マクロのタイプ。
使用可能な値:
0 - *(デフォルト)* Text macro;
1 - Secret macro;
2 - Vault secret.|
|description|string|マクロの説明。|
|automatic|integer|マクロがディスカバリルールによって制御されるかどうかを定義します。
使用可能な値:
0 - *(デフォルト)* マクロはユーザーによって管理されます;
1 - マクロはディスカバリルールによって管理されます。
ユーザーは自動マクロを作成できません。
自動マクロを更新するには、[手動に変換](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule)されている必要があります。
[comment]: # ({/c73e8f15-5a3a9f9f})