[comment]: # aside: 1
[comment]: # ({ee4a2645-28092341})
# Objeto de macro de usuário
Os seguintes objetos estão diretamente relacionados à API `usermacro`.
[comment]: # ({/ee4a2645-28092341})
[comment]: # ({2f5f2156-e654cd12})
### Macro global
O objeto macro global possui as seguintes propriedades.
|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|globalmacroid|ID|ID da macro global.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *somente leitura*
- *obrigatório* para operações de atualização|
|macro|string|String da macro.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *obrigatório* para operações de criação|
|value|string|Valor da macro.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *somente gravação* se `type` estiver definido como "Macro secreta"
- *obrigatório* para operações de criação|
|type|integer|Tipo de macro.
Valores possíveis:
0 - *(padrão)* Macro de texto;
1 - Macro secreta;
2 - Segredo do Vault.|
|description|string|Descrição da macro.|
[comment]: # ({/2f5f2156-e654cd12})
[comment]: # ({c73e8f15-5a3a9f9f})
### Macro de host
O objeto macro de host define uma macro disponível em um host, protótipo de host ou template. Possui as seguintes propriedades.
|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|hostmacroid|ID|ID da macro de host.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *somente leitura*
- *obrigatório* para operações de atualização|
|hostid|ID|ID do host ao qual a macro pertence.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *constante*
- *obrigatório* para operações de criação|
|macro|string|String da macro.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *obrigatório* para operações de criação|
|value|string|Valor da macro.
[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):
- *somente gravação* se `type` estiver definido como "Macro secreta"
- *obrigatório* para operações de criação|
|type|integer|Tipo de macro.
Valores possíveis:
0 - *(padrão)* Macro de texto;
1 - Macro secreta;
2 - Segredo do Vault.|
|description|string|Descrição da macro.|
|automatic|integer|Define se a macro é controlada por regra de descoberta.
Valores possíveis:
0 - *(padrão)* Macro é gerenciada pelo usuário;
1 - Macro é gerenciada por regra de descoberta.
O usuário não tem permissão para criar macro automática.
Para atualizar macro automática, ela deve ser [convertida para manual](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule).|
[comment]: # ({/c73e8f15-5a3a9f9f})