# Convenções de nomenclatura de Runbook

## Nomes de ficheiros no Github

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

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`, `grupo`, `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á mostrado como:

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

Categorias comuns

* Geral
* Segurança
* Correio
* Informações do Utilizador

Pode definir categorias adicionais, mas não contextos.

### Qual é o objetivo 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 tenham 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 Azure Automation Account. 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 estarão visíveis para outros clientes.

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

Exemplo: quer oferecer um runbook "Private Runbook" no contexto de grupos do Azure AD e da categoria "General". Daria a este o nome `group_general_private-runbook` na sua Azure Automation Account.

Isto terá o seguinte aspeto 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: 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.