# Convenções de Nomenclatura de Runbooks

## Nomes de ficheiros no GitHub

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

Os traços ("-") serão convertidos em espaços. As pastas são usadas para separar os 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 `prefixo rjgit-`, seguido do contexto, seja `org`, `grupo`, `user` 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` chamado `add-additional-alias.ps1` será mostrado como:

* `rjgit-user_general_add-additional-alias` na conta Azure Automation 
* "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 é a finalidade disto?

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

## Runbooks privados / específicos do cliente

Pode alojar runbooks privados (locais) na sua conta Azure Automation. 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 `prefixo rjgit-` prefixo da convenção de nomenclatura, mantendo intacta o resto da estrutura de nomes.

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

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

Será apresentado no Portal RealmJoin como:

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