# Runbook-Namenskonventionen

## Dateinamen in GitHub

Wir erwarten eine bestimmte Datei- und Namensstruktur in dem [gemeinsamen Runbook-Repository](https://github.com/realmjoin/realmjoin-runbooks). RealmJoin importiert diese Ordner und Dateien von GitHub in das Azure-Automation-Konto des Kunden.

Bindestriche ("-") werden in Leerzeichen umgewandelt. Ordner werden verwendet, um Runbooks in "Kontext" und "Kategorie" zu unterteilen, z. B. `user\general`. Dateinamen sollten den Zweck des Skripts beschreiben. 

Alle importierten Runbooks haben das Präfix `rjgit-`, gefolgt vom Kontext, entweder `Org`, `Gruppe`, `user` dann die Kategorie, zum Beispiel `_general_`, `_security_`, `_mail_` und dem Namen des Skripts selbst, wie zum Beispiel `add-additional-alias`.

### Beispiel:

Ein Runbook in Github in `user\general` mit dem Namen `add-additional-alias.ps1` wird angezeigt als:

* `rjgit-user_general_add-additional-alias` im Azure Automation-Konto 
* "Add Additional Alias" im RealmJoin-Portal auf einem Benutzerobjekt in der Runbook-Kategorie "General".

Häufige Kategorien

* Allgemein
* Sicherheit
* E-Mail
* Benutzerinformationen

Sie können zusätzliche Kategorien definieren, aber keine Kontexte.

### Wozu dient das?

Dies ermöglicht es, die Runbooks im RealmJoin-Portal automatisch auszufüllen und zu benennen. Außerdem ermöglicht das `rjgit-` Präfix, Namenskonflikte mit lokalen/kundenspezifischen Runbooks zu vermeiden. Runbooks ohne dieses Präfix werden von der Importlogik von RealmJoin nicht berührt.

## Private / kundenspezifische Runbooks

Sie können private (lokale) Runbooks in Ihrem Azure Automation-Konto hosten. Diese Runbooks werden im RealmJoin-Portal genauso wie die gemeinsamen Runbooks angezeigt. Lokale Runbooks werden von unserem Synchronisierungsprozess nicht berührt und sind für andere Kunden nicht sichtbar.

Um ein lokales Runbook zu erstellen, entfernen Sie das `rjgit-` Präfix aus der Namenskonvention und behalten Sie die restliche Namensstruktur unverändert bei.

Beispiel: Sie möchten ein Runbook "Private Runbook" im Kontext von Azure AD-Gruppen und der Kategorie "General" anbieten. Sie würden es nennen `group_general_private-runbook` in Ihrem Azure Automation-Konto.

So sieht das in Azure Automation aus:

![Runbook-Namen in GitHub / Azure Automation](https://2298793958-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)

Im RealmJoin-Portal wird es dargestellt als:

![Runbook-Namen im RealmJoin-Portal](https://2298793958-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)