Convenções de nomenclatura de runbooks

Nomes de ficheiros no GitHub

Esperamos uma determinada estrutura de ficheiro e de nomenclatura no repositório partilhado de runbooks. O RealmJoin irá 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 ex. 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, 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 denominado 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 User na categoria de runbook "General".

Categorias comuns

• Geral

• Security

• Correio

• Userinfo

Pode definir categorias adicionais, mas não contextos.

Qual é a finalidade disto?

Isto permite preencher e dar nome aos runbooks automaticamente 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 ficarã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 intacta.

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

Isto ficará assim no Azure Automation:

Nomes de runbooks no GitHub / Azure Automation

Será apresentado no Portal RealmJoin como:

Nomes de runbooks no Portal RealmJoin