> 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/automatizacao/runbooks/naming-conventions.md).

# Convenções de nomenclatura de runbooks

Convenções de nomenclatura de runbooks do RealmJoin: como o contexto e a categoria mapeiam os nomes de runbooks do repositório partilhado para o Azure Automation e o portal.

## Nomes de arquivos no GitHub

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

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

Todos os runbooks importados têm o prefixo `rjgit-`, seguido pelo contexto, seja `org`, `group`, `user` ou `device` 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á exibido como:

* `rjgit-user_general_add-additional-alias` na conta de Automação do Azure
* "Add Additional Alias" no portal do RealmJoin em um objeto User na categoria de runbook "General".

Categorias comuns

* Geral
* Segurança
* E-mail
* Informações do usuário

Você pode definir categorias adicionais, mas não contextos.

### Qual é o propósito disso?

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

## Runbooks privados / específicos do cliente

Você pode hospedar runbooks privados (locais) na sua conta de Automação do Azure. Esses runbooks aparecerão no portal do RealmJoin assim como os runbooks compartilhados. Os runbooks locais não serão afetados pelo nosso processo de sincronização e não ficarão visíveis para outros clientes.

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

Exemplo: Você quer oferecer um runbook "Private Runbook" no contexto de grupos do Azure AD e da categoria "General". Você o nomearia `group_general_private-runbook` na sua conta de Automação do Azure.

Isso ficará assim no Azure Automation:

![Nomes de runbooks no GitHub / Azure Automation](https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fdv7DajK5q1sVfnlQKurb%2Fnaming-ing1.png?alt=media\&token=136ada07-f577-4210-bd23-4cae6e83fce0)

Ele será apresentado no portal do RealmJoin como:

![Nomes de runbooks no portal do RealmJoin](https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FwGCdu4ikL2Qvubpf3K2a%2Fnaming-ing2.png?alt=media\&token=917652eb-4cec-4607-8165-f62356477c87)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
