> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automacao/runbooks/naming-conventions.md).

# Convenções de Nomenclatura de Runbooks

## Nomes de ficheiros no GitHub

Esperamos uma determinada estrutura de ficheiros e de nomenclatura no [repositório de runbooks partilhado](https://github.com/realmjoin/realmjoin-runbooks). RealmJoin importará estas pastas e ficheiros do GitHub para a conta do Azure Automation dos clientes.

Os travessões ("-") serão convertidos em espaços. As pastas são usadas para separar runbooks em "contexto" e "categoria", por exemplo `user\general`. Os nomes dos ficheiros devem descrever a finalidade do script.

Todos os runbooks importados têm um prefixo de `rjgit-`, seguido pelo contexto, seja `org`, `grupo`, `utilizador` e depois a categoria, por exemplo `_general_`, `_security_`, `_mail_` e o nome do próprio script, como `add-additional-alias`.

### Exemplo:

Um runbook no GitHub em `user\general` nomeado `add-additional-alias.ps1` será apresentado como:

* `rjgit-user_general_add-additional-alias` na conta do Azure Automation
* "Add Additional Alias" no Portal do RealmJoin num objeto de utilizador na categoria de runbook "General".

Categorias comuns

* General
* Segurança
* Mail
* Userinfo

Pode definir categorias adicionais, mas não contextos.

### Qual é o objetivo disto?

Isto permite preencher e nomear automaticamente os runbooks no Portal do RealmJoin. Além disso, o `rjgit-` prefixo permite evitar conflitos de nomes com runbooks locais/do cliente. Os runbooks que não tiverem este prefixo não serão afetados pela lógica de importação do RealmJoin.

## Runbooks privados / específicos do cliente

Pode alojar runbooks privados (locais) na sua conta do Azure Automation. Estes runbooks aparecerão no Portal do RealmJoin tal como os runbooks partilhados. Os runbooks locais não serão afetados pelo nosso processo de sincronização e não serão visíveis para outros clientes.

Para criar um runbook local, remova o `rjgit-` prefixo da convenção de nomenclatura, mantendo intacto o resto da estrutura de nomenclatura.

Exemplo: pretende disponibilizar um runbook "Private Runbook" no contexto de grupos do Azure AD e da categoria "General". Deverá nomeá-lo `group_general_private-runbook` na sua conta do Azure Automation.

Isto terá o seguinte aspeto no Azure Automation:

![Nomes de runbooks no GitHub / Azure Automation](/files/8a2ef318397cbb858d4d5bdd8f0392f21e14be26)

Será apresentado no Portal do RealmJoin como:

![Nomes de runbooks no Portal do RealmJoin](/files/5fd9afb86751958099633ea93e0761db6e3f66e0)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.realmjoin.com/pt/automacao/runbooks/naming-conventions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.