> 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 nomeação de RunBooks

## Nomes de ficheiros no GitHub

Esperamos uma determinada estrutura de ficheiros e de nomenclatura no [repositório de runbooks partilhados](https://github.com/realmjoin/realmjoin-runbooks). O RealmJoin importará estas pastas e ficheiros do GitHub para a Conta de Automação do Azure dos clientes.

Os traços ("-") 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 o propósito do script.

Todos os runbooks importados têm um prefixo de `rjgit-`, seguido do contexto, seja `org`, `group`, `utilizador` 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` chamado `add-additional-alias.ps1` será apresentado como:

* `rjgit-user_general_add-additional-alias` na Conta de Automação do Azure
* "Add Additional Alias" no Portal RealmJoin num objeto User na categoria de runbook "General".

Categorias comuns

* Geral
* Segurança
* Mail
* Userinfo

Pode definir categorias adicionais, mas não contextos.

### Qual é a finalidade disto?

Isto permite preencher e nomear automaticamente os runbooks no Portal RealmJoin. Além disso, o `rjgit-` prefixo permite evitar conflitos de nomenclatura 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 de Automação do Azure. Estes runbooks aparecerão no Portal 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 o restante da estrutura de nomenclatura intacto.

Exemplo: pretende disponibilizar um runbook "Private Runbook" no contexto de grupos do Azure AD e na categoria "General". Daria o nome de `group_general_private-runbook` na sua Conta de Automação do Azure.

Isto ficará assim no Azure Automation:

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

Será apresentado no Portal RealmJoin como:

![Nomes de runbooks no Portal 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:

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

The question should be specific, self-contained, and written in natural language.
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.