# Conventions de nommage des runbooks

## Noms de fichiers dans GitHub

Nous attendons une certaine structure de fichiers et de nommage dans le [dépôt de runbooks partagés](https://github.com/realmjoin/realmjoin-runbooks). RealmJoin importera ces dossiers et fichiers depuis GitHub dans le compte Azure Automation du client.

Les tirets ("-") seront convertis en espaces. Les dossiers sont utilisés pour séparer les runbooks en "contexte" et "catégorie", par exemple `user\general`. Les noms de fichiers doivent décrire l’objectif du script.

Tous les runbooks importés ont un préfixe de `rjgit-`, suivi du contexte, soit `org`, `groupe`, `utilisateur` puis la catégorie, par exemple `_general_`, `_security_`, `_mail_` et le nom du script lui-même, comme `add-additional-alias`.

### Exemple :

Un runbook dans GitHub dans `user\general` nommé `add-additional-alias.ps1` sera affiché comme :

* `rjgit-user_general_add-additional-alias` dans le compte Azure Automation
* « Add Additional Alias » dans le portail RealmJoin sur un objet utilisateur dans la catégorie de runbook « General ».

Catégories courantes

* Général
* Sécurité
* Courrier
* Informations utilisateur

Vous pouvez définir des catégories supplémentaires, mais pas de contextes.

### Quel est le but de cela ?

Cela permet de renseigner et de nommer automatiquement les runbooks dans le portail RealmJoin. De plus, le `rjgit-` préfixe permet d’éviter les conflits de nommage avec les runbooks locaux/clients. Les runbooks ne possédant pas ce préfixe ne seront pas affectés par la logique d’import de RealmJoin.

## Runbooks privés / spécifiques au client

Vous pouvez héberger des runbooks privés (locaux) dans votre compte Azure Automation. Ces runbooks apparaîtront dans le portail RealmJoin tout comme les runbooks partagés. Les runbooks locaux ne seront pas affectés par notre processus de synchronisation et ne seront pas visibles par les autres clients.

Pour créer un runbook local, supprimez le `rjgit-` préfixe de la convention de nommage tout en conservant intacte le reste de la structure de nommage.

Exemple : vous souhaitez proposer un runbook « Private Runbook » dans le contexte des groupes Azure AD et la catégorie « General ». Vous le nommeriez `group_general_private-runbook` dans votre compte Azure Automation.

Cela ressemblera à ceci dans Azure Automation :

![Noms de runbooks dans GitHub / Azure Automation](/files/1c3e42313e41a250b6c82c4f478954865a059f48)

Il sera présenté dans le portail RealmJoin comme :

![Noms de runbooks dans le portail RealmJoin](/files/c74a31cbebf5008b9703ea4b9d52c39a2f89d1e1)


---

# 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/fr/automatisation/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.
