Benennungskonventionen für Runbooks

RealmJoin-Runbook-Benennungskonventionen: wie Kontext und Kategorie die Namen von Runbooks im gemeinsamen Repository in Azure Automation und im Portal abbilden.

Dateinamen in GitHub

Wir erwarten eine bestimmte Datei- und Namensstruktur im gemeinsamen Runbook-Repository. RealmJoin importiert diese Ordner und Dateien aus GitHub in das Azure Automation-Konto des Kunden.

Bindestriche ("-") werden in Leerzeichen umgewandelt. Ordner werden verwendet, um Runbooks in „Kontext“ und „Kategorie“ zu trennen, 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, Benutzer dann der 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“.

Gängige Kategorien

• Allgemein
• Sicherheit
• E-Mail
• Benutzerinfo

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

Wozu dient das?

Dadurch können die Runbooks im RealmJoin-Portal automatisch befüllt und benannt werden. Außerdem rjgit- hilft das 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 genau 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, während die restliche Namensstruktur unverändert bleibt.

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.

In Azure Automation sieht das so aus:

Runbook-Namen in GitHub / Azure Automation

Es wird im RealmJoin-Portal angezeigt als:

Runbook-Namen im RealmJoin-Portal